diff --git a/doc/JobTemplate/Documentation/index.rst b/doc/JobTemplate/Documentation/index.rst index 7e86deb..e923b85 100644 --- a/doc/JobTemplate/Documentation/index.rst +++ b/doc/JobTemplate/Documentation/index.rst @@ -5,11 +5,13 @@ Documentation The category *documentation* provides workflow templates implementing +* :ref:`JOBTMPL/VerifyDocs` - +* :ref:`JOBTMPL/SphinxDocumentation` - +* :ref:`JOBTMPL/LaTeXDocumentation` - .. toctree:: :hidden: VerifyDocs - CheckDocumentation - LaTeXDocumentation SphinxDocumentation + LaTeXDocumentation diff --git a/doc/JobTemplate/InstallPackage.rst b/doc/JobTemplate/Package/InstallPackage.rst similarity index 100% rename from doc/JobTemplate/InstallPackage.rst rename to doc/JobTemplate/Package/InstallPackage.rst diff --git a/doc/JobTemplate/Package.rst b/doc/JobTemplate/Package/Package.rst similarity index 100% rename from doc/JobTemplate/Package.rst rename to doc/JobTemplate/Package/Package.rst diff --git a/doc/JobTemplate/PublishOnPyPI.rst b/doc/JobTemplate/Package/PublishOnPyPI.rst similarity index 100% rename from doc/JobTemplate/PublishOnPyPI.rst rename to doc/JobTemplate/Package/PublishOnPyPI.rst diff --git a/doc/JobTemplate/Package/index.rst b/doc/JobTemplate/Package/index.rst new file mode 100644 index 0000000..fa610ee --- /dev/null +++ b/doc/JobTemplate/Package/index.rst @@ -0,0 +1,17 @@ +.. _JOBTMPL/Packaging: + +Packaging +######### + +The category *packaging* provides workflow templates implementing + +* :ref:`JOBTMPL/Package` - +* :ref:`JOBTMPL/InstallPackage` - +* :ref:`JOBTMPL/PublishOnPyPI` - + +.. toctree:: + :hidden: + + Package + InstallPackage + PublishOnPyPI diff --git a/doc/JobTemplate/PublishCoverageResults.rst b/doc/JobTemplate/Publish/PublishCoverageResults.rst similarity index 98% rename from doc/JobTemplate/PublishCoverageResults.rst rename to doc/JobTemplate/Publish/PublishCoverageResults.rst index 124aeb2..dd711ca 100644 --- a/doc/JobTemplate/PublishCoverageResults.rst +++ b/doc/JobTemplate/Publish/PublishCoverageResults.rst @@ -19,4 +19,4 @@ Instantiation Simple Example ============== -.. todo:: PublishCoverageResults:Simple example needs documentation. +.. todo:: PublishCoverageResults:Simple example needs documentation. \ No newline at end of file diff --git a/doc/JobTemplate/PublishReleaseNotes.rst b/doc/JobTemplate/Publish/PublishReleaseNotes.rst similarity index 100% rename from doc/JobTemplate/PublishReleaseNotes.rst rename to doc/JobTemplate/Publish/PublishReleaseNotes.rst diff --git a/doc/JobTemplate/PublishTestResults.rst b/doc/JobTemplate/Publish/PublishTestResults.rst similarity index 100% rename from doc/JobTemplate/PublishTestResults.rst rename to doc/JobTemplate/Publish/PublishTestResults.rst diff --git a/doc/JobTemplate/PublishToGitHubPages.rst b/doc/JobTemplate/Publish/PublishToGitHubPages.rst similarity index 100% rename from doc/JobTemplate/PublishToGitHubPages.rst rename to doc/JobTemplate/Publish/PublishToGitHubPages.rst diff --git a/doc/JobTemplate/Publish/index.rst b/doc/JobTemplate/Publish/index.rst new file mode 100644 index 0000000..bc04c70 --- /dev/null +++ b/doc/JobTemplate/Publish/index.rst @@ -0,0 +1,19 @@ +.. _JOBTMPL/Publish: + +Publish +####### + +The category *publish* provides workflow templates implementing + +* :ref:`JOBTMPL/PublishTestResults` - +* :ref:`JOBTMPL/PublishCoverageResults` - +* :ref:`JOBTMPL/PublishReleaseNotes` - +* :ref:`JOBTMPL/PublishToGitHubPages` - + +.. toctree:: + :hidden: + + PublishTestResults + PublishCoverageResults + PublishReleaseNotes + PublishToGitHubPages diff --git a/doc/JobTemplate/Documentation/CheckDocumentation.rst b/doc/JobTemplate/Quality/CheckDocumentation.rst similarity index 85% rename from doc/JobTemplate/Documentation/CheckDocumentation.rst rename to doc/JobTemplate/Quality/CheckDocumentation.rst index dc8dab0..fcfc7ae 100644 --- a/doc/JobTemplate/Documentation/CheckDocumentation.rst +++ b/doc/JobTemplate/Quality/CheckDocumentation.rst @@ -3,7 +3,7 @@ CheckDocumentation ################## -.. todo:: CheckDocumentation:Behavior needs documentation. +.. todo:: CheckDocumentation:Needs documentation. **Behavior:** diff --git a/doc/JobTemplate/StaticTypeCheck.rst b/doc/JobTemplate/Quality/StaticTypeCheck.rst similarity index 99% rename from doc/JobTemplate/StaticTypeCheck.rst rename to doc/JobTemplate/Quality/StaticTypeCheck.rst index 31598de..af8a8d6 100644 --- a/doc/JobTemplate/StaticTypeCheck.rst +++ b/doc/JobTemplate/Quality/StaticTypeCheck.rst @@ -1,4 +1,4 @@ -.. _JOBTMPL/StaticTypeChecking: +.. _JOBTMPL/StaticTypeCheck: StaticTypeCheck ############### diff --git a/doc/JobTemplate/Quality/index.rst b/doc/JobTemplate/Quality/index.rst new file mode 100644 index 0000000..11a8158 --- /dev/null +++ b/doc/JobTemplate/Quality/index.rst @@ -0,0 +1,15 @@ +.. _JOBTMPL/Quality: + +Quality +####### + +The category *quality* provides workflow templates implementing + +* :ref:`JOBTMPL/CheckDocumentation` - +* :ref:`JOBTMPL/StaticTypeCheck` - + +.. toctree:: + :hidden: + + StaticTypeCheck + CheckDocumentation diff --git a/doc/JobTemplate/TagReleaseCommit.rst b/doc/JobTemplate/Release/TagReleaseCommit.rst similarity index 100% rename from doc/JobTemplate/TagReleaseCommit.rst rename to doc/JobTemplate/Release/TagReleaseCommit.rst diff --git a/doc/JobTemplate/Release/index.rst b/doc/JobTemplate/Release/index.rst new file mode 100644 index 0000000..0573536 --- /dev/null +++ b/doc/JobTemplate/Release/index.rst @@ -0,0 +1,13 @@ +.. _JOBTMPL/Release: + +Release +####### + +The category *release* provides workflow templates implementing + +* :ref:`JOBTMPL/TagReleaseCommit` - + +.. toctree:: + :hidden: + + TagReleaseCommit diff --git a/doc/JobTemplate/ApplicationTesting.rst b/doc/JobTemplate/Testing/ApplicationTesting.rst similarity index 87% rename from doc/JobTemplate/ApplicationTesting.rst rename to doc/JobTemplate/Testing/ApplicationTesting.rst index 9aac4df..5b93f49 100644 --- a/doc/JobTemplate/ApplicationTesting.rst +++ b/doc/JobTemplate/Testing/ApplicationTesting.rst @@ -3,7 +3,7 @@ ApplicationTesting ################## -.. todo:: ApplicationTesting:Need introduction. +.. todo:: ApplicationTesting:Needs documentation. **Behavior:** diff --git a/doc/JobTemplate/UnitTesting.rst b/doc/JobTemplate/Testing/UnitTesting.rst similarity index 100% rename from doc/JobTemplate/UnitTesting.rst rename to doc/JobTemplate/Testing/UnitTesting.rst diff --git a/doc/JobTemplate/Testing/index.rst b/doc/JobTemplate/Testing/index.rst new file mode 100644 index 0000000..4dd822f --- /dev/null +++ b/doc/JobTemplate/Testing/index.rst @@ -0,0 +1,15 @@ +.. _JOBTMPL/Testing: + +Testing +####### + +The category *testing* provides workflow templates implementing + +* :ref:`JOBTMPL/UnitTesting` - +* :ref:`JOBTMPL/ApplicationTesting` - + +.. toctree:: + :hidden: + + UnitTesting + ApplicationTesting diff --git a/doc/JobTemplate/index.rst b/doc/JobTemplate/index.rst index 145e0e7..2fa9878 100644 --- a/doc/JobTemplate/index.rst +++ b/doc/JobTemplate/index.rst @@ -41,7 +41,7 @@ Workflow). They can also serve as an example for creating or deriving own job te .. rubric:: Code Quality - * :ref:`JOBTMPL/StaticTypeChecking` + * :ref:`JOBTMPL/StaticTypeCheck` * *code formatting (planned)* * *coding style (planned)* * *code linting (planned)* diff --git a/doc/index.rst b/doc/index.rst index 4785c92..52ea6ef 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -35,6 +35,13 @@ However, Python being equally popular and capable, usage of JS/TS might be bypas This repository gathers reusable CI tooling for testing, packaging and distributing Python projects and documentation. +GitHub Actions +************** + +* :ref:`ACTION/Releaser` +* :ref:`ACTION/WithPostStep` + + GitHub Action Job Templates *************************** @@ -76,7 +83,7 @@ Workflow): .. rubric:: Code Quality - * :ref:`JOBTMPL/StaticTypeChecking` + * :ref:`JOBTMPL/StaticTypeCheck` * *code formatting (planned)* * *coding style (planned)* * *code linting (planned)* @@ -122,19 +129,78 @@ Workflow): 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: +.. grid:: 2 -- Set the ``name`` input of job ``Parameters``. -- Specify the ``commands`` input of job ``StaticTypeCheck``. + .. grid-item:: + :columns: 6 + ``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: -GitHub Actions -************** + * Set the ``name`` input of job ``Parameters``. + * Specify the ``commands`` input of job ``StaticTypeCheck``. + + .. grid-item:: + :columns: 6 + + .. tab-set:: + + .. tab-item:: Simple Package + + .. code-block:: yaml + + 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 }} + + .. tab-item:: Namespace Package + + .. code-block:: yaml + + 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 }} + +.. image:: _static/pyTooling-Actions-SimplePackage.png -* :ref:`ACTION/Releaser` -* :ref:`ACTION/WithPostStep` References ********** @@ -199,17 +265,11 @@ License JobTemplate/AllInOne/index JobTemplate/Global/index JobTemplate/Documentation/index - JobTemplate/UnitTesting - JobTemplate/ApplicationTesting - JobTemplate/StaticTypeCheck - JobTemplate/PublishTestResults - JobTemplate/PublishCoverageResults - JobTemplate/Package - JobTemplate/InstallPackage - JobTemplate/PublishOnPyPI - JobTemplate/PublishToGitHubPages - JobTemplate/TagReleaseCommit - JobTemplate/PublishReleaseNotes + JobTemplate/Testing/index + JobTemplate/Quality/index + JobTemplate/Package/index + JobTemplate/Publish/index + JobTemplate/Release/index JobTemplate/Cleanup/index JobTemplate/Deprecated/index