Update output display to job summary (#3914)

* Update output display to job summary

* fix: handled exit-code of script

* added changelog message

diff --git a/CHANGES.md b/CHANGES.md
index 888824ee055e71dd9f3c7c2d6c15bd48742f652a..062a195717df8206e7af3790cf0bf47a7ce47748 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -48,6 +48,8 @@
 
 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
 
 
 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
 

+- The action output displayed in the job summary is now wrapped in Markdown (#3914)
+

 ### Documentation
 
 <!-- Major changes to documentation and policies. Small docs changes
 ### Documentation
 
 <!-- Major changes to documentation and policies. Small docs changes

diff --git a/action.yml b/action.yml
index 282fca43deac486dbf4145c3c8c812fdd94b7ba6..8b698ae3c8012b278e3818a2d0e0290d69eb171b 100644 (file)
--- a/action.yml
+++ b/action.yml
@@ -36,10 +36,24 @@ runs:
     - name: black
       run: |
         if [ "$RUNNER_OS" == "Windows" ]; then
     - name: black
       run: |
         if [ "$RUNNER_OS" == "Windows" ]; then

-          python $GITHUB_ACTION_PATH/action/main.py | tee -a $GITHUB_STEP_SUMMARY
+          runner="python"

         else
         else

-          python3 $GITHUB_ACTION_PATH/action/main.py | tee -a $GITHUB_STEP_SUMMARY
+          runner="python3"

         fi
         fi

+
+        out=$(${runner} $GITHUB_ACTION_PATH/action/main.py)
+        exit_code=$?
+
+        # 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
+
+        # Exit with the exit-code returned by Black
+        exit ${exit_code}

       env:
         # TODO: Remove once https://github.com/actions/runner/issues/665 is fixed.
         INPUT_OPTIONS: ${{ inputs.options }}
       env:
         # TODO: Remove once https://github.com/actions/runner/issues/665 is fixed.
         INPUT_OPTIONS: ${{ inputs.options }}