Improve

Author: yoanm

.github/actions/reports-group/codacy-uploader-action/action.yml

@@ -9,7 +9,9 @@ inputs:
     description: Codacy project token for the repository
     required: true
   override-commit:
-    description: Force the commit linked to the uploaded reports
+    description: |
+      Force the commit SHA linked to the uploaded reports.
+      Mostly useful for specific cases (e.g. `workflow_run` workflow).
     required: false
   follow-symbolic-links:
     description: Indicates whether to follow symbolic links when resolving `path`

.github/actions/reports-group/codecov-uploader-action/action.yml

@@ -9,19 +9,41 @@ inputs:
     description: Codecov upload token
     required: true
   override-commit:
-    description: Commit to link to the uploaded reports
+    description: |
+      Force the commit SHA linked to the uploaded reports.
+      Mostly useful for specific cases (e.g. `workflow_run` workflow).
+      
+      In case input is filled, `override-branch` input (as well as `override-pr` in case of `pull_request` event)
+      should be filled too in order to keep consitency between values !
     required: false
   override-branch:
-    description: Branch to link to the uploaded reports
+    description: |
+      Force the branch linked to the uploaded reports.
+      Mostly useful for specific cases (e.g. `workflow_run` workflow).
+      
+      In case input is filled, `override-commit` input (as well as `override-pr` in case of `pull_request` event)
+      should be filled too in order to keep consitency between values !
     required: false
   override-pr:
-    description: PR to link to the uploaded reports
+    description: |
+      Force the PR linked to the uploaded reports.
+      Mostly useful for specific cases (e.g. `workflow_run` workflow triggered by a `pull_request` workflow).
+      
+      In case input is filled, `override-commit` and `override-branch` inputs should be filled too in order
+      to keep consitency between values !
     required: false
   override-build:
-    description: Workflow run to link to the uploaded reports
+    description: |
+      Workflow run ID to link to the uploaded reports.
+      Mostly useful for specific cases (e.g. `workflow_run` workflow).
     required: false
   override-build-url:
-    description: Workflow run url to link to the uploaded reports
+    description: |
+      Workflow run url to link to the uploaded reports.
+      Usually something like `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}` (based on GHA environment variables).
+      Mostly useful for specific cases (e.g. `workflow_run` workflow).
+      
+      In case input is filled, `override-build` input most likely need to be filled too in order to keep consitency between values !
     required: false
   follow-symbolic-links:
     description: Indicates whether to follow symbolic links when resolving `path`

.github/workflows/CI.yml

@@ -244,8 +244,8 @@ jobs:
       contents: read
       checks: write # For the check run creation !
     outputs:
-      commit-sha: ${{ steps.fetch-workflow-metadata-action.outputs.commit-sha }}
-      run-id: ${{ steps.fetch-workflow-metadata-action.outputs.run-id }}
+      commit-sha: ${{ steps.fetch-workflow-metadata.outputs.commit-sha }}
+      run-id: ${{ steps.fetch-workflow-metadata.outputs.run-id }}
     steps:
       - uses: ./custom-action-repo/.github/actions/reports-group/attach-check-run-to-triggering-workflow-action
         with:
@@ -254,7 +254,7 @@ jobs:
           fails-on-triggering-workflow-failure: true
 
       - uses: ./custom-action-repo/.github/actions/reports-group/fetch-workflow-metadata-action
-        id: fetch-workflow-metadata-action
+        id: fetch-workflow-metadata
 
   codacy-uploader:
     name: Codacy

.github/workflows/codacy-upload-from-artifacts.yml

@@ -9,16 +9,20 @@ on:
       run-id:
         description: |
           The id of the workflow run where the artifacts were uploaded from (default to current run).
-          In case artefacts have been uploadded from another run, this input must be filled with original workflow !
+          In case artefacts have been uploadded from another run, this input must be filled with original workflow run id !
         required: false
         default: "${{ github.run_id }}"
         type: string
       override-commit:
-        description: Force the commit linked to the uploaded reports
+        description: |
+          Force the commit SHA linked to the uploaded reports.
+          Mostly useful for specific cases (e.g. `workflow_run` workflow).
+        type: string
         required: false
       follow-symbolic-links:
         description: Indicates whether to follow symbolic links when resolving groups path
-        default: 'false'
+        type: boolean
+        default: false
 
     secrets:
       PROJECT_TOKEN:
@@ -40,7 +44,7 @@ jobs:
       reports: ${{ steps.upload.outputs.reports }}
     permissions:
       contents: read
-      checks: write # For the check run creation !
+      checks: write # For the check run creation ! @TODO check if doable to use inputs there and set read rather than write if ${{ !inputs.with-check-run }}
     steps:
       # @TODO move actions to a dedicated repo and remove the checkout
       - uses: actions/checkout@v4

.github/workflows/codecov-upload-from-artifacts.yml

@@ -9,33 +9,60 @@ on:
       run-id:
         description: |
           The id of the workflow run where the artifacts were uploaded from (default to current run).
-          In case artefacts have been uploadded from another run, this input must be filled with original workflow !
+          In case artefacts have been uploadded from another run, this input must be filled with original workflow run id !
         required: false
         default: "${{ github.run_id }}"
         type: string
       override-commit:
-        description: Commit to link to the uploaded reports
+        description: |
+          Force the commit SHA linked to the uploaded reports.
+          Mostly useful for specific cases (e.g. `workflow_run` workflow).
+          
+          In case input is filled, `override-branch` input (as well as `override-pr` in case of `pull_request` event)
+          should be filled too in order to keep consitency between values !
         type: string
         required: false
       override-branch:
-        description: Branch to link to the uploaded reports
+        description: |
+          Force the branch linked to the uploaded reports.
+          Mostly useful for specific cases (e.g. `workflow_run` workflow).
+          
+          In case input is filled, `override-commit` input (as well as `override-pr` in case of `pull_request` event)
+          should be filled too in order to keep consitency between values !
         type: string
         required: false
       override-pr:
-        description: PR to link to the uploaded reports
+        description: |
+          Force the PR linked to the uploaded reports.
+          Mostly useful for specific cases (e.g. `workflow_run` workflow triggered by a `pull_request` workflow).
+          
+          In case input is filled, `override-commit` and `override-branch` inputs should be filled too in order
+          to keep consitency between values !
         type: string
         required: false
       override-build:
-        description: Workflow run to link to the uploaded reports
+        description: |
+          Workflow run ID to link to the uploaded reports.
+          Mostly useful for specific cases (e.g. `workflow_run` workflow).
+          
+          When `run-id` input is provided, this input should most likely have the same value.
         type: string
         required: false
       override-build-url:
-        description: Workflow run url to link to the uploaded reports
+        description: |
+          Workflow run url to link to the uploaded reports.
+          Usually something like `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}` (based on GHA environment variables).
+          Mostly useful for specific cases (e.g. `workflow_run` workflow).
+          
+          In case input is filled, `override-build` input most likely need to be filled too in order to keep consitency between values !
         type: string
         required: false
       follow-symbolic-links:
-        description: Indicates whether to follow symbolic links when resolving `path`
-        default: 'false'
+        description: |
+          Indicates whether to follow symbolic links when resolving glob path.
+          When looking for group directory for instance.
+        type: boolean
+        default: false
     secrets:
       TOKEN:
         required: true
@@ -53,7 +80,7 @@ jobs:
       list-for-output: ${{ steps.find-groups.outputs.list }}
     permissions:
       contents: read
-      checks: write # For the check run creation !
+      checks: write # For the check run creation ! @TODO check if doable to use inputs there and set read rather than write if ${{ !inputs.with-check-run }}
     steps:
       # @TODO move actions to a dedicated repo and remove the checkout
       - uses: actions/checkout@v4
@@ -132,7 +159,7 @@ jobs:
       matrix: ${{ fromJson(needs.prepare.outputs.matrix) }}
     permissions:
       contents: read
-      checks: write # For the check run creation !
+      checks: write # For the check run creation ! @TODO check if doable to use inputs there and set read rather than write if ${{ !inputs.with-check-run }}
     steps:
       - name: DEBUG matrix
         run: echo 'matrix='"'"'${{ toJson(matrix) }}'"'"