mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 11:06:56 +08:00
185 lines
4.4 KiB
ReStructuredText
185 lines
4.4 KiB
ReStructuredText
.. include:: shields.inc
|
|
|
|
.. raw:: latex
|
|
|
|
\part{Introduction}
|
|
|
|
.. only:: html
|
|
|
|
| |SHIELD:svg:pyTooling-github| |SHIELD:svg:pyTooling-src-license| |SHIELD:svg:pyTooling-ghp-doc| |SHIELD:svg:pyTooling-doc-license|
|
|
| |SHIELD:svg:pyTooling-tag| |SHIELD:svg:pyTooling-date|
|
|
|
|
.. Disabled shields: |SHIELD:svg:pyTooling-gitter|
|
|
|
|
.. only:: latex
|
|
|
|
|SHIELD:png:pyTooling-github| |SHIELD:png:pyTooling-src-license| |SHIELD:png:pyTooling-ghp-doc| |SHIELD:png:pyTooling-doc-license|
|
|
|SHIELD:png:pyTooling-tag| |SHIELD:png:pyTooling-date|
|
|
|
|
.. Disabled shields: |SHIELD:svg:pyTooling-gitter|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
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):
|
|
|
|
.. hlist::
|
|
:columns: 2
|
|
|
|
* **Global Templates**
|
|
|
|
* :ref:`JOBTMPL/Parameters`
|
|
|
|
* **Unit Tests, Code Coverage, Code Quality, ...**
|
|
|
|
* :ref:`JOBTMPL/UnitTesting`
|
|
* :ref:`JOBTMPL/CodeCoverage`
|
|
* :ref:`JOBTMPL/StaticTypeChecking`
|
|
* *code formatting (planned)*
|
|
* *coding style (planned)*
|
|
* *code linting (planned)*
|
|
|
|
* **Build and Packaging**
|
|
|
|
* :ref:`JOBTMPL/Package`
|
|
|
|
* **Documentation**
|
|
|
|
* :ref:`JOBTMPL/VerifyDocumentation`
|
|
* :ref:`JOBTMPL/BuildTheDocs`
|
|
|
|
* **Releasing, Publishing**
|
|
|
|
* :ref:`JOBTMPL/GitHubReleasePage`
|
|
* :ref:`JOBTMPL/PyPI`
|
|
* :ref:`JOBTMPL/PublishTestResults`
|
|
* :ref:`JOBTMPL/PublishToGitHubPages`
|
|
|
|
* **Cleanups**
|
|
|
|
* :ref:`JOBTMPL/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
|
|
**************
|
|
|
|
* :ref:`ACTION/Releaser`
|
|
* :ref:`ACTION/WithPostStep`
|
|
|
|
References
|
|
**********
|
|
|
|
- `hdl/containers#48 <https://github.com/hdl/containers/issues/48>`__
|
|
|
|
Contributors
|
|
************
|
|
|
|
* `Patrick Lehmann <https://GitHub.com/Paebbels>`__
|
|
* `Unai Martinez-Corral <https://GitHub.com/umarcor>`__ (Maintainer)
|
|
* `and more... <https://GitHub.com/pyTooling/Actions/graphs/contributors>`__
|
|
|
|
|
|
License
|
|
*******
|
|
|
|
.. only:: html
|
|
|
|
This Python package (source code) is licensed under `Apache License 2.0 <Code-License.html>`__. |br|
|
|
The accompanying documentation is licensed under `Creative Commons - Attribution 4.0 (CC-BY 4.0) <Doc-License.html>`__.
|
|
|
|
.. only:: latex
|
|
|
|
This Python package (source code) is licensed under **Apache License 2.0**. |br|
|
|
The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**.
|
|
|
|
|
|
------------------------------------
|
|
|
|
.. |docdate| date:: %b %d, %Y - %H:%M
|
|
|
|
.. only:: html
|
|
|
|
This document was generated on |docdate|.
|
|
|
|
.. toctree::
|
|
:caption: Introduction
|
|
:hidden:
|
|
|
|
Background
|
|
RepositoryStructure
|
|
Instantiation
|
|
Deveopment
|
|
Dependency
|
|
Releases
|
|
|
|
.. raw:: latex
|
|
|
|
\part{Main Documentation}
|
|
|
|
.. toctree::
|
|
:caption: Actions
|
|
:hidden:
|
|
|
|
Action/index
|
|
Action/Releaser
|
|
Action/With-post-step
|
|
|
|
.. toctree::
|
|
:caption: Job Templates
|
|
:hidden:
|
|
|
|
JobTemplate/index
|
|
JobTemplate/Parameters
|
|
JobTemplate/CoverageCollection
|
|
JobTemplate/UnitTesting
|
|
JobTemplate/StaticTypeCheck
|
|
JobTemplate/PublishTestResults
|
|
JobTemplate/Package
|
|
JobTemplate/PublishOnPyPI
|
|
JobTemplate/VerifyDocs
|
|
JobTemplate/BuildTheDocs
|
|
JobTemplate/PublishToGitHubPages
|
|
JobTemplate/Release
|
|
JobTemplate/ArtifactCleanUp
|
|
|
|
.. raw:: latex
|
|
|
|
\part{Appendix}
|
|
|
|
.. toctree::
|
|
:caption: Appendix
|
|
:hidden:
|
|
|
|
License
|
|
Doc-License
|
|
TODO
|