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 Action Job Templates

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

Global Templates
- Parameters
Unit Tests, Code Coverage, Code Quality, …
- UnitTesting
- CoverageCollection
- StaticTypeCheck
- code formatting (planned)
- coding style (planned)
- code linting (planned)
Build and Packaging
- Package

Documentation
- VerifyDocs
- BuildTheDocs
Releasing, Publishing
Cleanups
- ArtifactCleanUp

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.

GitHub Actions

References

hdl/containers#48

Contributors

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).