Updated and documented dependencies.

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

.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

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

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

.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

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

.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
 

.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

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

.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
 

.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

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

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

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
+* BuildTheDocs
-  * actions/setup-python
+
-  * geekyeggo/delete-artifact
+  * :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`

doc/JobTemplate/Parameters.rst

@@ -8,6 +8,14 @@ GitHub Actions workflows (see `actions/runner#480 <https://github.com/actions/ru
 
 It generates output parameters with artifact names and a job matrix to be used in later running jobs.
 
+**Behavior:**
+
+.. todo:: Parameters:Behavior Needs documentation.
+
+**Dependencies:**
+
+*None*
+
 Instantiation
 *************
 

doc/JobTemplate/Release.rst

@@ -27,7 +27,7 @@ This job creates a Release Page on GitHub.
 
 **Dependencies:**
 
-* :gh:`actions/create-release`
+* :gh:`actions/create-release` (unmaintained)
 
 Instantiation
 *************

releaser/README.md

@@ -79,7 +79,7 @@ jobs:
     steps:
 
     # Clone repository
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     # Build your application, tool, artifacts, etc.
     - name: Build
@@ -162,7 +162,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