From 21b3b3dc118a5a0872ea141cb4fb2b050f459f54 Mon Sep 17 00:00:00 2001
From: Matthew Rodusek <7519129+bitwizeshift@users.noreply.github.com>
Date: Mon, 11 Dec 2023 23:18:42 -0500
Subject: [PATCH] =?UTF-8?q?=F0=9F=A9=B9=20Fix=20`GITHUB=5FSUMMARY=5FSTEP`?=
 =?UTF-8?q?=20message=20for=20promote?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The promotion workflow was using double-quotes instead of single-quotes
(`"` instead of `'`). This is resulting in backticks being interpreted
as a subshell instead of what it's meant to be, which is a markdown
code-span identifier. Additionally, the table format was incorrect,
which leads to unexpected appearance.

This fixes the above by using `'`, and by adding the appropriate
separator so that the table will display correctly.
---
 .github/workflows/promote.yaml | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/promote.yaml b/.github/workflows/promote.yaml
index 706f7d6..918ec15 100644
--- a/.github/workflows/promote.yaml
+++ b/.github/workflows/promote.yaml
@@ -42,20 +42,22 @@ jobs:
         if: success()
         run: |
           sha1=$(git rev-parse --short HEAD)
-          echo "# ⏩ Accepted changes from `develop` into `master`"  >> "${GITHUB_STEP_SUMMARY}"
-          echo ""                                                   >> "${GITHUB_STEP_SUMMARY}"
-          echo "${sha1} is the new HEAD of `master`"                >> "${GITHUB_STEP_SUMMARY}"
-          echo ""                                                   >> "${GITHUB_STEP_SUMMARY}"
-          echo "## Summary"                                         >> "${GITHUB_STEP_SUMMARY}"
-          echo ""                                                   >> "${GITHUB_STEP_SUMMARY}"
-          echo "Below are commits being promoted"                   >> "${GITHUB_STEP_SUMMARY}"
-          echo ""                                                   >> "${GITHUB_STEP_SUMMARY}"
+          echo '# ⏩ Accepted changes from `develop` into `master`'  >> "${GITHUB_STEP_SUMMARY}"
+          echo ''                                                   >> "${GITHUB_STEP_SUMMARY}"
+          echo '${sha1} is the new HEAD of `master`'                >> "${GITHUB_STEP_SUMMARY}"
+          echo ''                                                   >> "${GITHUB_STEP_SUMMARY}"
+          echo '## Summary'                                         >> "${GITHUB_STEP_SUMMARY}"
+          echo ''                                                   >> "${GITHUB_STEP_SUMMARY}"
+          echo 'Below are commits being promoted'                   >> "${GITHUB_STEP_SUMMARY}"
+          echo ''                                                   >> "${GITHUB_STEP_SUMMARY}"
 
           old_sha1=${{steps.update-branch.outputs.old_sha1}}
           new_sha1=${{steps.update-branch.outputs.new_sha1}}
+          url_base=https://github.com/${{github.repository}}/commit/
           echo "| SHA1 | Message |" >> "${GITHUB_STEP_SUMMARY}"
+          echo "|------|---------|" >> "${GITHUB_STEP_SUMMARY}"
           git log                                                              \
-            --pretty="format:| %h | %s |"                                      \
+            --pretty='format:| [`%h`](https://github.com/${{github.repository}}/commit/%h) | %s |' \
             --no-show-signature                                                \
             ${old_sha1}..${new_sha1} >> "${GITHUB_STEP_SUMMARY}"
 
@@ -63,6 +65,6 @@ jobs:
         if: failure()
         run: |
           sha1=$(git rev-parse --short HEAD)
-          echo "# 🛑 Rejected changes from `develop` into `master`"           >> "${GITHUB_STEP_SUMMARY}"
-          echo ""                                                            >> "${GITHUB_STEP_SUMMARY}"
-          echo "A failure occurred, and `master` was not able to be updated" >> "${GITHUB_STEP_SUMMARY}"
+          echo '# 🛑 Rejected changes from `develop` into `master`'           >> "${GITHUB_STEP_SUMMARY}"
+          echo ''                                                            >> "${GITHUB_STEP_SUMMARY}"
+          echo 'A failure occurred, and `master` was not able to be updated' >> "${GITHUB_STEP_SUMMARY}"