Add summary parameter to action (#3958)

psf · Oct 23, 2023 · a7643fa · a7643fa
1 parent d291c23
commit a7643fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -43,7 +43,8 @@
 
 ### Integrations
 
-<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
+- The summary output for GitHub workflows is now suppressible using the `summary`
+  parameter. (#3958)
 
 ### Documentation
 

diff --git a/action.yml b/action.yml
@@ -27,6 +27,10 @@ inputs:
     description: 'Python Version specifier (PEP440) - e.g. "21.5b1"'
     required: false
     default: ""
+  summary:
+    description: "Whether to add the output to the workflow summary"
+    required: false
+    default: true
 branding:
   color: "black"
   icon: "check-circle"
@@ -47,10 +51,12 @@ runs:
         # Display the raw output in the step
         echo "${out}"
 
-        # Display the Markdown output in the job summary
-        echo "\`\`\`python" >> $GITHUB_STEP_SUMMARY
-        echo "${out}" >> $GITHUB_STEP_SUMMARY
-        echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+        if [ "${{ inputs.summary }}" == "true" ]; then
+          # Display the Markdown output in the job summary
+          echo "\`\`\`python" >> $GITHUB_STEP_SUMMARY
+          echo "${out}" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+        fi
 
         # Exit with the exit-code returned by Black
         exit ${exit_code}