---

pyTooling Actions Documentation

pyTooling Actions are reusable steps and workflows for GitHub Actions easing the creation and maintenance of workflows for Python projects on GitHub.

Introduction

GitHub Actions workflows, actions and documentation are mostly focused on JavaScript/TypeScript as the scripting language for writing reusable CI code. However, Python being equally popular and capable, usage of JS/TS might be bypassed, with some caveats. This repository gathers reusable CI tooling for testing, packaging and distributing Python projects and documentation.

GitHub Actions

Post-Processing

• with-post-step

Deprecated

• Releaser

GitHub Action Job Templates

The following list categorizes all pre-defined job templates, which can be instantiated in a pipeline (GitHub Action Workflow):

All-In-One

• CompletePipeline
  
  
  
  

Pipeline Setup

• Parameters

• PrepareJob

• ExtractConfiguration

Documentation

• CheckDocumentation

• VerifyDocs

• SphinxDocumentation

• LatexDocumentation

Unit Tests, Code Coverage

• ApplicationTesting

• UnitTesting

Code Quality

• StaticTypeCheck

• code formatting (planned)

• coding style (planned)

• code linting (planned)

Build and Packaging

• Package

• InstallPackage

Publishing

• PublishOnPyPI

• PublishTestResults

• PublishCoverageResults

• PublishToGitHubPages

Releasing

• PublishReleaseNotes

• TagReleaseCommit

Cleanup

• IntermediateCleanUp

• ArtifactCleanUp

Deprecated

• CoverageCollection

• NightlyRelease

• BuildTheDocs

Example Pipelines

ExamplePipeline.yml is an example Workflow which uses all of the Reusable Workflows. Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway. Minimal required modifications are the following:

• Set the name input of job Parameters.

• Specify the commands input of job StaticTypeCheck.

Simple Package

name: Pipeline

on:
  push:
  workflow_dispatch:
  schedule:
# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
    - cron: '0 22 * * 5'

jobs:
  SimplePackage:
    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
    with:
      package_name: myPackage
      codecov:      true
      codacy:       true
      dorny:        true
    secrets:
      PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
      CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}

Namespace Package

name: Pipeline

on:
  push:
  workflow_dispatch:
  schedule:
# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
    - cron: '0 22 * * 5'

jobs:
  NamespacePackage:
    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r5
    with:
      package_namespace: myFramework
      package_name:      Extension
      codecov:           true
      codacy:            true
      dorny:             true
    secrets:
      PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
      CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}

References

• hdl/containers#48

Contributors

• Patrick Lehmann

• Unai Martinez-Corral (Maintainer)

• and more…

License

This Python package (source code) is licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).