Use the action

Author: yoanm

.github/actions/reports-group/attach-check-run-to-triggering-workflow-action/action.yml

@@ -3,15 +3,15 @@ description: |
   Create a reports group directory under provided `path`, with a metada file and a copy of all `files`
   Reports are expected to share the same format !
 inputs:
-  head-sha:
-    description: TODO
+  name:
+    description: Status check name
+    required: true
+  commit-sha:
+    description: Commit SHA to attach to the check
     required: true
   github-token:
-    description: TODO
+    description: Github Authentication token used to create the check through GitHub API
     required: true
-  name:
-    description: Status check name
-    required: false
   status:
     description: Status check status
     required: false

.github/actions/reports-group/attach-check-run-to-triggering-workflow-action/dist/index.js

@@ -5,8 +5,9 @@ async function run() {
     const {GITHUB_REPOSITORY: repository} = process.env;
     const [repoOwner, repoName] = repository.split('/');
     /** INPUTS **/
+    const commitSha = core.getInput('commit-sha', {required: true});
     const checkName = core.getInput('name', {required: true});
-    const headSha = core.getInput('head-sha', {required: true});
+    const githubToken = core.getInput('github-token', {required: true});
 
     // Following inputs are not required and may not have any value attached !
     const checkStatus = core.getInput('status');
@@ -23,7 +24,7 @@ async function run() {
         async () => {
             const res = {
                 name: checkName,
-                head_sha: headSha,
+                head_sha: commitSha,
                 details_url: undefinedIfEmpty(detailsUrl),
                 external_id: undefinedIfEmpty(externalId),
                 status: undefinedIfEmpty(checkStatus),
@@ -41,7 +42,7 @@ async function run() {
     );
 
     const { data: checkRun } = await core.group('Call API', async () => {
-        const octokit = github.getOctokit(core.getInput('github-token', {required: true}));
+        const octokit = github.getOctokit(githubToken);
 
         return octokit.rest.checks.create(requestParams);
     });

.github/actions/reports-group/attach-check-run-to-triggering-workflow-action/dist/index.js.map

@@ -27,7 +27,7 @@ on:
 # @TODO Investigate: `workflow_run` don't create a status check on the related PR !
 # Would it be handy/secure/not to complex to create a reports-group/check-run-from-workflow-run which:
 # - Would need to be added as first workflow wtep in order to create a `in-progress` check-run with all info fetched from the triggering workflow
-#   - Add a `fail-if-caller-failed` option which would create `failed` check-run and exit with an error ?
+#   - Add a `fails-on-caller-failure` option which would create `failed` check-run and exit with an error ? (a bit more handy than end-user having to check it)
 # - Would update the check-run during post-process with the current status of the triggered workflow
 jobs:
   upload:
@@ -37,11 +37,18 @@ jobs:
       groups: ${{ steps.upload.outputs.groups }}
       reports: ${{ steps.upload.outputs.reports }}
     steps:
-      # @TODO move reports-group/codacy-uploader action to a dedicated repo and remove the checkout
+      # @TODO move actions to a dedicated repo and remove the checkout
       - uses: actions/checkout@v4
         with:
           path: custom-action-repo
 
+      - uses: ./custom-action-repo/.github/actions/reports-group/attach-check-run-to-triggering-workflow-action
+        with:
+          name: "${{ github.workflow }} (${{ github.event.workflow.name}}) / Codacy / Upload all reports"
+          commit-sha: "${{ ('workflow_run' == github.event_name && ('pull_request' == github.event.workflow_run.event || 'push' == github.event.workflow_run.event) && github.event.workflow_run.head_sha) || ('pull_request' == github.event_name && github.event.pull_request.head.sha) || ('push' == github.event_name && github.sha) || null }}"
+          github-token: ${{ github.token }}
+          status: queued
+
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:

.github/actions/reports-group/attach-check-run-to-triggering-workflow-action/index.js

@@ -34,6 +34,13 @@ jobs:
         with:
           path: custom-action-repo
 
+      - uses: ./custom-action-repo/.github/actions/reports-group/attach-check-run-to-triggering-workflow-action
+        with:
+          name: "${{ github.workflow }} (${{ github.event.workflow.name}}) / Codecov / Prepare"
+          commit-sha: "${{ ('workflow_run' == github.event_name && ('pull_request' == github.event.workflow_run.event || 'push' == github.event.workflow_run.event) && github.event.workflow_run.head_sha) || ('pull_request' == github.event_name && github.event.pull_request.head.sha) || ('push' == github.event_name && github.sha) || null }}"
+          github-token: ${{ github.token }}
+          status: queued
+
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:
@@ -106,6 +113,13 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
+      - uses: ./custom-action-repo/.github/actions/reports-group/attach-check-run-to-triggering-workflow-action
+        with:
+          name: "${{ github.workflow }} (${{ github.event.workflow.name}}) / Codecov / ${{ matrix.artifact}} - ${{ matrix.path }}"
+          commit-sha: "${{ ('workflow_run' == github.event_name && ('pull_request' == github.event.workflow_run.event || 'push' == github.event.workflow_run.event) && github.event.workflow_run.head_sha) || ('pull_request' == github.event_name && github.event.pull_request.head.sha) || ('push' == github.event_name && github.sha) || null }}"
+          github-token: ${{ github.token }}
+          status: queued
+
       - name: Download '${{ matrix.artifact }}' artifact
         uses: actions/download-artifact@v4
         with: