🧪 Add custom names to failing linting jobs

ansible · Sep 6, 2024 · 63f65f2 · 63f65f2
1 parent cf37fd7
commit 63f65f2
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -609,48 +609,58 @@ jobs:
         - ''
         xfail:
         - false
+        check-name:
+        - ''
         include:
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: python-check-blanket-noqa --all-files
           xfail: true
+          check-name: python-check-blanket-noqa
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: flake8 --all-files
           xfail: true
+          check-name: flake8
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: mypy-py313 --all-files
           xfail: true
+          check-name: MyPy @ Python 3.13
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: mypy-py312 --all-files
           xfail: true
+          check-name: MyPy @ Python 3.12
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: mypy-py311 --all-files
           xfail: true
+          check-name: MyPy @ Python 3.11
         - runner-vm-os: ubuntu-latest
           python-version: 3.11
           toxenv: pre-commit
           environment-variables: ''
           tox-run-posargs: pylint --all-files
           xfail: true
+          check-name: PyLint
       fail-fast: false
     uses: ./.github/workflows/reusable-tox.yml
     with:
       cache-key-files: >-
         ${{ needs.pre-setup.outputs.cache-key-files }}
+      check-name: >-
+        ${{ matrix.check-name }}
       dists-artifact-name: >-
         ${{ needs.pre-setup.outputs.dists-artifact-name }}
       environment-variables: >-

diff --git a/.github/workflows/reusable-tox.yml b/.github/workflows/reusable-tox.yml
@@ -18,6 +18,10 @@ on:
         description: Dependency files cache
         required: true
         type: string
+      check-name:
+        description: A custom name for the Checks API-reported status
+        required: false
+        type: string
       dists-artifact-name:
         description: Workflow artifact name containing dists
         required: true
@@ -109,11 +113,14 @@ jobs:
   tox:
     name: >-
       ${{
-        inputs.toxenv
-      }}@🐍${{
-        inputs.python-version
-      }}@${{
-        inputs.runner-vm-os
+        inputs.check-name
+        && inputs.check-name
+        || format(
+             '{0}@🐍{1}@{2}',
+             inputs.toxenv,
+             inputs.python-version,
+             inputs.runner-vm-os
+           )
       }}
 
     runs-on: ${{ inputs.runner-vm-os }}