From be1eaa4de48287d62ff889ffda59a505550f40e8 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Wed, 2 Nov 2022 00:22:55 +0100 Subject: [PATCH] Updated and documented dependencies. --- .github/workflows/ArtifactCleanUp.yml | 4 +-- .github/workflows/BuildTheDocs.yml | 4 +-- .github/workflows/CoverageCollection.yml | 10 ++++---- .github/workflows/Package.yml | 6 ++--- .github/workflows/Pipeline.yml | 2 +- .github/workflows/PublishOnPyPI.yml | 6 ++--- .github/workflows/PublishTestResults.yml | 4 +-- .github/workflows/PublishToGitHubPages.yml | 8 +++--- .github/workflows/StaticTypeCheck.yml | 6 ++--- .github/workflows/TestReleaser.yml | 6 ++--- .github/workflows/UnitTesting.yml | 6 ++--- .github/workflows/VerifyDocs.yml | 4 +-- doc/Action/Releaser.rst | 4 +-- doc/Dependency.rst | 29 +++++++++++++++++----- doc/JobTemplate/Parameters.rst | 8 ++++++ doc/JobTemplate/Release.rst | 2 +- releaser/README.md | 4 +-- 17 files changed, 69 insertions(+), 44 deletions(-) diff --git a/.github/workflows/ArtifactCleanUp.yml b/.github/workflows/ArtifactCleanUp.yml index 1ddff51..3b4dd9d 100644 --- a/.github/workflows/ArtifactCleanUp.yml +++ b/.github/workflows/ArtifactCleanUp.yml @@ -45,12 +45,12 @@ jobs: - name: 🗑️ Delete package Artifacts if: ${{ ! startsWith(github.ref, 'refs/tags') }} - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v2 with: name: ${{ inputs.package }} - name: 🗑️ Delete remaining Artifacts if: ${{ inputs.remaining != '' }} - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v2 with: name: ${{ inputs.remaining }} diff --git a/.github/workflows/BuildTheDocs.yml b/.github/workflows/BuildTheDocs.yml index 5d49b03..d223e99 100644 --- a/.github/workflows/BuildTheDocs.yml +++ b/.github/workflows/BuildTheDocs.yml @@ -38,7 +38,7 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 🛳️ Build documentation uses: buildthedocs/btd@v0 @@ -46,7 +46,7 @@ jobs: skip-deploy: true - name: 📤 Upload 'documentation' artifacts - uses: actions/upload-artifact@master + uses: actions/upload-artifact@v3 with: name: ${{ inputs.artifact }} path: doc/_build/html diff --git a/.github/workflows/CoverageCollection.yml b/.github/workflows/CoverageCollection.yml index b5f6a97..4a87cb9 100644 --- a/.github/workflows/CoverageCollection.yml +++ b/.github/workflows/CoverageCollection.yml @@ -67,10 +67,10 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 🐍 Setup Python ${{ inputs.python_version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ inputs.python_version }} @@ -136,7 +136,7 @@ jobs: - name: 📤 Upload 'Coverage Report' artifact continue-on-error: true - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ${{ inputs.artifact }} path: ${{ steps.getVariables.outputs.coverage_report_html_directory }} @@ -145,7 +145,7 @@ jobs: - name: 📊 Publish coverage at CodeCov continue-on-error: true - uses: codecov/codecov-action@v1 + uses: codecov/codecov-action@v3 with: file: ${{ steps.getVariables.outputs.coverage_report_xml }} flags: unittests @@ -153,7 +153,7 @@ jobs: - name: 📉 Publish coverage at Codacy continue-on-error: true - uses: codacy/codacy-coverage-reporter-action@master + uses: codacy/codacy-coverage-reporter-action@v1 with: project-token: ${{ secrets.codacy_token }} coverage-reports: ${{ steps.getVariables.outputs.coverage_report_xml }} diff --git a/.github/workflows/Package.yml b/.github/workflows/Package.yml index d2a640d..c64a215 100644 --- a/.github/workflows/Package.yml +++ b/.github/workflows/Package.yml @@ -48,10 +48,10 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 🐍 Setup Python ${{ inputs.python_version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ inputs.python_version }} @@ -101,7 +101,7 @@ jobs: run: python setup.py bdist_wheel - name: 📤 Upload wheel artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ${{ inputs.artifact }} path: dist/ diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml index dfaa29b..45d0aed 100644 --- a/.github/workflows/Pipeline.yml +++ b/.github/workflows/Pipeline.yml @@ -26,6 +26,6 @@ jobs: steps: - name: 🗑️ Delete artifacts - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v2 with: name: Documentation diff --git a/.github/workflows/PublishOnPyPI.yml b/.github/workflows/PublishOnPyPI.yml index 1475375..2e120ca 100644 --- a/.github/workflows/PublishOnPyPI.yml +++ b/.github/workflows/PublishOnPyPI.yml @@ -52,13 +52,13 @@ jobs: steps: - name: 📥 Download artifacts '${{ inputs.artifact }}' from 'Package' job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ inputs.artifact }} path: dist/ - name: 🐍 Setup Python ${{ inputs.python_version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ inputs.python_version }} @@ -80,6 +80,6 @@ jobs: run: twine upload dist/*.whl - name: 🗑️ Delete packaging Artifacts - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v2 with: name: ${{ inputs.artifact }} diff --git a/.github/workflows/PublishTestResults.yml b/.github/workflows/PublishTestResults.yml index 5844e33..1d5bdb6 100644 --- a/.github/workflows/PublishTestResults.yml +++ b/.github/workflows/PublishTestResults.yml @@ -39,10 +39,10 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Download Artifacts - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: path: artifacts diff --git a/.github/workflows/PublishToGitHubPages.yml b/.github/workflows/PublishToGitHubPages.yml index 57ce6ec..e323193 100644 --- a/.github/workflows/PublishToGitHubPages.yml +++ b/.github/workflows/PublishToGitHubPages.yml @@ -48,24 +48,24 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 📥 Download artifacts '${{ inputs.doc }}' from 'BuildTheDocs' job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ inputs.doc }} path: public - name: 📥 Download artifacts '${{ inputs.coverage }}' from 'Coverage' job if: ${{ inputs.coverage != '' }} - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ inputs.coverage }} path: public/coverage - name: 📥 Download artifacts '${{ inputs.typing }}' from 'StaticTypeCheck' job if: ${{ inputs.typing != '' }} - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ inputs.typing }} path: public/typing diff --git a/.github/workflows/StaticTypeCheck.yml b/.github/workflows/StaticTypeCheck.yml index a94a026..3aa3f12 100644 --- a/.github/workflows/StaticTypeCheck.yml +++ b/.github/workflows/StaticTypeCheck.yml @@ -57,10 +57,10 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 🐍 Setup Python ${{ inputs.python_version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ inputs.python_version }} @@ -76,7 +76,7 @@ jobs: - name: 📤 Upload 'Static Typing Report' artifact if: ${{ inputs.artifact != '' }} continue-on-error: true - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ${{ inputs.artifact }} path: ${{ inputs.report }} diff --git a/.github/workflows/TestReleaser.yml b/.github/workflows/TestReleaser.yml index e1749e5..4311548 100644 --- a/.github/workflows/TestReleaser.yml +++ b/.github/workflows/TestReleaser.yml @@ -45,7 +45,7 @@ jobs: env: DOCKER_BUILDKIT: 1 steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Build container image run: docker build -t ghcr.io/pytooling/releaser -f releaser/Dockerfile releaser @@ -62,7 +62,7 @@ jobs: Composite: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - run: echo "Build some tool and generate some (versioned) artifacts" > artifact-$(date -u +"%Y-%m-%dT%H-%M-%SZ").txt @@ -122,7 +122,7 @@ jobs: - Composite runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - run: echo "Build some tool and generate some (versioned) artifacts" > artifact-$(date -u +"%Y-%m-%dT%H-%M-%SZ").txt diff --git a/.github/workflows/UnitTesting.yml b/.github/workflows/UnitTesting.yml index 1f43961..afa75ad 100644 --- a/.github/workflows/UnitTesting.yml +++ b/.github/workflows/UnitTesting.yml @@ -81,7 +81,7 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: '🟦 Setup MSYS2' if: matrix.system == 'msys2' @@ -93,7 +93,7 @@ jobs: - name: 🐍 Setup Python ${{ matrix.python }} if: matrix.system != 'msys2' - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python }} @@ -131,7 +131,7 @@ jobs: - name: 📤 Upload 'TestReportSummary.xml' artifact if: inputs.artifact != '' - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ${{ inputs.artifact }}-${{ matrix.system }}-${{ matrix.python }} path: ${{ inputs.tests_directory }}/TestReportSummary.xml diff --git a/.github/workflows/VerifyDocs.yml b/.github/workflows/VerifyDocs.yml index 45b8f23..18c0ee4 100644 --- a/.github/workflows/VerifyDocs.yml +++ b/.github/workflows/VerifyDocs.yml @@ -39,10 +39,10 @@ jobs: steps: - name: ⏬ Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: 🐍 Setup Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ inputs.python_version }} diff --git a/doc/Action/Releaser.rst b/doc/Action/Releaser.rst index 69b7328..95a4212 100644 --- a/doc/Action/Releaser.rst +++ b/doc/Action/Releaser.rst @@ -85,7 +85,7 @@ The following block shows a minimal YAML workflow file: steps: # Clone repository - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 # Build your application, tool, artifacts, etc. - name: Build @@ -177,7 +177,7 @@ For prototyping purposes, the following job might be useful: if: github.event_name != 'pull_request' && (github.ref == 'refs/heads/master' || contains(github.ref, 'refs/tags/'>`__) steps: - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 - shell: bash run: pip install PyGithub --progress-bar off diff --git a/doc/Dependency.rst b/doc/Dependency.rst index 4cf2f5d..440313a 100644 --- a/doc/Dependency.rst +++ b/doc/Dependency.rst @@ -1,12 +1,29 @@ Dependencies ############ -* Parameters +This is a summary of dependencies used by the provided job templates. For more details, see each job template. - * *None* +* Actions provided by GitHub -* PublishOnPyPI + * :gh:`actions/checkout` + * :gh:`actions/upload-artifact` + * :gh:`actions/download-artifact` + * :gh:`actions/create-release` (unmaintained) + * :gh:`actions/setup-python` - * actions/download-artifact - * actions/setup-python - * geekyeggo/delete-artifact +* BuildTheDocs + + * :gh:`buildthedocs/btd` + +* Code Quality Services + + * :gh:`codecov/codecov-action` + * :gh:`codacy/codacy-coverage-reporter-action` + +* Reporting + + * :gh:`dorny/test-reporter` + +* Miscellaneous + + * :gh:`geekyeggo/delete-artifact` diff --git a/doc/JobTemplate/Parameters.rst b/doc/JobTemplate/Parameters.rst index 8e0a3b4..fc1dc5a 100644 --- a/doc/JobTemplate/Parameters.rst +++ b/doc/JobTemplate/Parameters.rst @@ -8,6 +8,14 @@ GitHub Actions workflows (see `actions/runner#480