diff --git a/doc/JobTemplate/ArtifactCleanUp.rst b/doc/JobTemplate/ArtifactCleanUp.rst index f9a2fe7..bc9ae54 100644 --- a/doc/JobTemplate/ArtifactCleanUp.rst +++ b/doc/JobTemplate/ArtifactCleanUp.rst @@ -12,7 +12,7 @@ This job removes artifacts used to exchange data from job to job. **Dependencies:** -* geekyeggo/delete-artifact@v1 +* :gh:`geekyeggo/delete-artifact` Instantiation diff --git a/doc/JobTemplate/CoverageCollection.rst b/doc/JobTemplate/CoverageCollection.rst index 973b348..0f5b714 100644 --- a/doc/JobTemplate/CoverageCollection.rst +++ b/doc/JobTemplate/CoverageCollection.rst @@ -35,11 +35,11 @@ Setup a secret (e.g. ``codacy_token``) in GitHub to handover the Codacy project **Dependencies:** -* actions/checkout@v2 -* actions/setup-python@v2 -* actions/upload-artifact@v2 -* codecov/codecov-action@v1 -* codacy/codacy-coverage-reporter-action@master +* :gh:`actions/checkout` +* :gh:`actions/setup-python` +* :gh:`actions/upload-artifact` +* :gh:`codecov/codecov-action` +* :gh:`codacy/codacy-coverage-reporter-action` Instantiation diff --git a/doc/JobTemplate/Package.rst b/doc/JobTemplate/Package.rst index 416a391..dd2f45f 100644 --- a/doc/JobTemplate/Package.rst +++ b/doc/JobTemplate/Package.rst @@ -19,9 +19,9 @@ as an artifact. **Dependencies:** -* actions/checkout@v2 -* actions/setup-python@v2 -* actions/upload-artifact@v2 +* :gh:`actions/checkout` +* :gh:`actions/setup-python` +* :gh:`actions/upload-artifact` Instantiation ************* diff --git a/doc/JobTemplate/PublishTestResults.rst b/doc/JobTemplate/PublishTestResults.rst index 12b493e..9e890b5 100644 --- a/doc/JobTemplate/PublishTestResults.rst +++ b/doc/JobTemplate/PublishTestResults.rst @@ -3,6 +3,27 @@ PublishTestResults ################## +This job downloads all artifacts and uploads jUnit XML reports as a Markdown page to GitHub Actions to visualize the +results a an item in the job list. For publishing, :gh:`dorny/test-reporter` is used. + +**Behavior:** + +1. Checkout repository +2. Download (all) artifacts +3. Publish test results as a markdown report page to GitHub Actions. + +.. note:: + + The :gh:`actions/download-artifact` does not support wildcards to specify a subset of artifacts for downloading. + Thus, all artifacts need to be downloaded. + +**Dependencies:** + +* :gh:`actions/checkout` +* :gh:`actions/download-artifact` +* :gh:`dorny/test-reporter` + + Instantiation ************* @@ -11,31 +32,56 @@ Simple Example .. code-block:: yaml - TBD + jobs: + PublishTestResults: + uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r0 Complex Example =============== - - .. code-block:: yaml - TBD + jobs: + CodeCoverage: + # ... + + UnitTesting: + # ... + + PublishTestResults: + uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r0 + needs: + - CodeCoverage + - UnitTesting Template Parameters ******************* -TBD 1 -===== +report_files +============ -TBD +Pattern of jUnit report files to publish as Markdown. -TBD 1 -===== +The parameter can be a comma separated list. Wildcards are supported. -TBD +.. hint:: -Template Results -**************** + All artifacts are downloaded into directory ``artifacts``, thus the pattern should include this directory as a + prefix. -*None* ++----------+----------+---------------------------------+ +| Required | Type | Default | ++==========+==========+=================================+ +| optional | string | ``artifacts/**/*.xml`` | ++----------+----------+---------------------------------+ + + +Secrets +******* + +This job template needs no secrets. + +Results +******* + +This job template has no output parameters. diff --git a/doc/JobTemplate/UnitTesting.rst b/doc/JobTemplate/UnitTesting.rst index c0d8af5..65aa0ed 100644 --- a/doc/JobTemplate/UnitTesting.rst +++ b/doc/JobTemplate/UnitTesting.rst @@ -18,9 +18,9 @@ file. **Dependencies:** -* actions/checkout@v2 -* actions/setup-python@v2 -* actions/upload-artifact@v2 +* :gh:`actions/checkout` +* :gh:`actions/setup-python` +* :gh:`actions/upload-artifact` Instantiation *************