Enable SonarQube actions to download reports from the default workflow

smartcontractkit · Oct 16, 2024 · 3d0601b · 3d0601b
1 parent 5f5ebd5
commit 3d0601b
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 50 deletions.
diff --git a/.changeset/forty-ears-juggle.md b/.changeset/forty-ears-juggle.md
@@ -0,0 +1,8 @@
+---
+"ci-sonarqube-go": minor
+"ci-sonarqube-ts": minor
+---
+
+Let SonarQube actions to fetch reports from a default workflow (the workflow the
+action is specified) if names of the workflows that produce reports are not
+mentioned
diff --git a/actions/ci-sonarqube-go/README.md b/actions/ci-sonarqube-go/README.md
@@ -16,8 +16,10 @@ sonarqube:
       with:
         # sonarqube inputs
         include-lint: "true"
-        test-report-workflow: "ci-core.yaml"
-        lint-report-workflow: "golingci-lint.yaml"
+        # if workflow names are not used, artifacts will be downloaded
+        # from a workflow this action is added to
+        test-report-workflow: "ci-core.yaml" # optional
+        lint-report-workflow: "golingci-lint.yaml" # optional
         sonar-token: ${{ secrets.SONAR_TOKEN }}
         sonar-host-url: ${{ secrets.SONAR_HOST_URL }}
 ```
diff --git a/actions/ci-sonarqube-go/action.yml b/actions/ci-sonarqube-go/action.yml
@@ -19,11 +19,8 @@ inputs:
     description: "sonarqube host url"
     required: false
   test-report-workflow:
-    description:
-      "workflow file name which uploaded test report artifacts [i.e.
-      ci-core.yaml]"
-    required: true
-    default: ${{ github.run_id }}
+    description: "workflow file name which uploaded test report artifacts"
+    required: false
   test-report-artifact:
     description: "Name of artifact containing junit test and coverage results"
     required: false
@@ -37,11 +34,8 @@ inputs:
     requried: false
     default: "coverage.txt"
   lint-report-workflow:
-    description:
-      "workflow file name which uploaded lint report artifacts [i.e.
-      golangci-lint.yaml]"
-    required: true
-    default: ${{ github.run_id }}
+    description: "workflow file name which uploaded lint report artifacts"
+    required: false
   lint-report-artifact:
     description: "Name of artifact containing golangci-lint report"
     requried: false
@@ -64,6 +58,10 @@ runs:
       with:
         fetch-depth: ${{ inputs.checkout-repo-fetch-depth }}
 
+    - name: Download all reports (no report-workflow name is specified)
+      if: inputs.test-report-workflow == '' || inputs.lint-report-workflow == ''
+      uses: actions/download-artifact@v4.1.8 # v4.1.8
+
     - name: Download test-report artifact using workflow file name
       if: inputs.test-report-workflow != ''
       uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
@@ -73,14 +71,6 @@ runs:
         workflow_conclusion: "" # ignore workflow status to let the latest artifact be downloaded
         if_no_artifact_found: warn
 
-    - name: Download test-report artifact from current workflow
-      if: inputs.test-report-workflow == ''
-      uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
-      with:
-        name: ${{ inputs.test-report-artifact }}
-        workflow_conclusion: ""
-        if_no_artifact_found: warn
-
     - name: Download lint-report artifact using workflow file name
       if: inputs.lint-report-workflow != ''
       uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
@@ -90,14 +80,6 @@ runs:
         workflow_conclusion: ""
         if_no_artifact_found: warn
 
-    - name: Download lint-report artifact from current workflow
-      if: inputs.lint-report-workflow == ''
-      uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
-      with:
-        name: ${{ inputs.lint-report-artifact }}
-        workflow_conclusion: ""
-        if_no_artifact_found: warn
-
     - name: SonarQube scan without lint
       if: inputs.include-lint == 'false'
       uses: sonarsource/sonarqube-scan-action@aecaf43ae57e412bd97d70ef9ce6076e672fe0a9 # v2.3.0

diff --git a/actions/ci-sonarqube-ts/README.md b/actions/ci-sonarqube-ts/README.md
@@ -16,8 +16,10 @@ sonarqube:
       with:
         # sonarqube inputs
         include-lint: "true"
-        test-report-workflow: "ci-core.yaml"
-        lint-report-workflow: "ts-lint.yaml"
+        # if workflow names are not used, artifacts will be downloaded
+        # from a workflow this action is added to
+        test-report-workflow: "ci-core.yaml" # optional
+        lint-report-workflow: "ts-lint.yaml" # optional
         sonar-token: ${{ secrets.SONAR_TOKEN }}
         sonar-host-url: ${{ secrets.SONAR_HOST_URL }}
 ```
diff --git a/actions/ci-sonarqube-ts/action.yml b/actions/ci-sonarqube-ts/action.yml
@@ -20,8 +20,7 @@ inputs:
     required: false
   test-report-workflow:
     description: "workflow file name which uploaded test report artifacts"
-    required: true
-    default: ${{ github.run_id }}
+    required: false
   test-report-artifact:
     description: "Name of artifact containing junit test and coverage results"
     required: false
@@ -36,8 +35,7 @@ inputs:
     default: "lcov.info"
   lint-report-workflow:
     description: "workflow file name which uploaded lint report artifacts"
-    required: true
-    default: ${{ github.run_id }}
+    required: false
   lint-report-artifact:
     description: "Name of artifact containing eslint report"
     requried: false
@@ -60,6 +58,10 @@ runs:
       with:
         fetch-depth: ${{ inputs.checkout-repo-fetch-depth }}
 
+    - name: Download all reports (no report-workflow name is specified)
+      if: inputs.test-report-workflow == '' || inputs.lint-report-workflow == ''
+      uses: actions/download-artifact@v4.1.8 # v4.1.8
+
     - name: Download test-report artifact using workflow file name
       if: inputs.test-report-workflow != ''
       uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
@@ -69,14 +71,6 @@ runs:
         workflow_conclusion: "" # ignore workflow status to let the latest artifact be downloaded
         if_no_artifact_found: warn
 
-    - name: Download test-report artifact from current workflow
-      if: inputs.test-report-workflow == ''
-      uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
-      with:
-        name: ${{ inputs.test-report-artifact }}
-        workflow_conclusion: ""
-        if_no_artifact_found: warn
-
     - name: Download lint-report artifact using workflow file name
       if: inputs.lint-report-workflow != ''
       uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
@@ -86,14 +80,6 @@ runs:
         workflow_conclusion: ""
         if_no_artifact_found: warn
 
-    - name: Download lint-report artifact from current workflow
-      if: inputs.lint-report-workflow == ''
-      uses: dawidd6/action-download-artifact@bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 # v6
-      with:
-        name: ${{ inputs.lint-report-artifact }}
-        workflow_conclusion: ""
-        if_no_artifact_found: warn
-
     - name: SonarQube scan without lint
       if: inputs.include-lint == 'false'
       uses: sonarsource/sonarqube-scan-action@aecaf43ae57e412bd97d70ef9ce6076e672fe0a9 # v2.3.0