doc: update usage examples

upload SARIF debug artifacts only when debug is enabled
redhat-plumbers-in-action · Feb 17, 2025 · 95a8d25 · 95a8d25
1 parent 21dd323
commit 95a8d25
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/.github/workflows/differential-shellcheck.yml b/.github/workflows/differential-shellcheck.yml
@@ -47,15 +47,15 @@ jobs:
           display-engine: sarif-fmt
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - if: always()
+      - if: runner.debug == '1' && !cancelled()
         name: Upload artifact with defects in SARIF format
         uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:
           name: Differential ShellCheck SARIF
           path: ${{ steps.ShellCheck.outputs.sarif }}
           retention-days: 7
 
-      - if: always()
+      - if: !cancelled()
         name: Upload artifact with defects in XHTML format
         uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:

diff --git a/README.md b/README.md
@@ -95,7 +95,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - if: always()
+      - if: runner.debug == '1' && !cancelled()
         name: Upload artifact with ShellCheck defects in SARIF format
         uses: actions/upload-artifact@v4
         with:
@@ -364,14 +364,14 @@ Relative path to the SARIF file containing detected defects. Example of how to u
   name: Differential ShellCheck
   uses: redhat-plumbers-in-action/differential-shellcheck@v5
 
-- if: always()
+- if: runner.debug == '1' && !cancelled()
   name: Upload artifact with ShellCheck defects in SARIF format
   uses: actions/upload-artifact@v4
   with:
     name: Differential ShellCheck SARIF
     path: ${{ steps.ShellCheck.outputs.sarif }}
 
-- if: always()
+- if: !cancelled()
   name: Upload SARIF to GitHub using github/codeql-action/upload-sarif
   uses: github/codeql-action/upload-sarif@v2
   with:
@@ -391,7 +391,7 @@ Relative path to the HTML file containing detected defects. Example of how to us
   name: Differential ShellCheck
   uses: redhat-plumbers-in-action/differential-shellcheck@v5
 
-- if: always()
+- if: !cancelled()
   name: Upload artifact with ShellCheck defects in HTML format
   uses: actions/upload-artifact@v4
   with: