Add a job summary.

Author: desrosj

.github/workflows/backport.yml

@@ -24,7 +24,7 @@ on:
         type: string
         default: ''
       repo-source:
-        description: 'Repository to stage changes from.'
+        description: 'Repository to merge changes from.'
         required: false
         type: choice
         default: 'upstream'
@@ -166,6 +166,7 @@ jobs:
           fi
 
       - name: Merge PRs
+        id: merge-prs
         if: ${{ inputs['commit-sha'] == '' && inputs.pr_numbers != '' }}
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -182,6 +183,8 @@ jobs:
           IFS=',' read -ra PR_LIST <<< "${INPUTS_PR_NUMBERS}"
 
           UPSTREAM_URL="https://github.com/${STEPS_UPSTREAM_OUTPUTS_REPO}.git"
+          RESULTS=""
+          FAILED=false
 
           for PR_NUMBER in "${PR_LIST[@]}"; do
             PR_NUMBER=$(echo "$PR_NUMBER" | tr -d ' ')
@@ -190,6 +193,7 @@ jobs:
             PR_TITLE=$(echo "$PR_DATA" | jq -r '.title')
             MERGE_COMMIT=$(echo "$PR_DATA" | jq -r '.mergeCommit.oid')
 
+            set +e
             if [ -n "$MERGE_COMMIT" ] && [ "$MERGE_COMMIT" != "null" ]; then
               # PR is merged: cherry-pick its merge commit.
               # Determine if it is a merge commit or squash commit.
@@ -214,16 +218,33 @@ jobs:
               MERGE_BASE=$(git merge-base "$PR_HEAD_SHA" "$BASE_SHA")
               git diff "$MERGE_BASE" "$PR_HEAD_SHA" | git apply --index
             fi
+            APPLY_EXIT=$?
+            set -e
 
-            git commit -m "$PR_TITLE"
+            if [ $APPLY_EXIT -eq 0 ]; then
+              git commit -m "$PR_TITLE"
+              RESULTS="${RESULTS}${PR_NUMBER}=✅ "
+            else
+              git cherry-pick --abort 2>/dev/null || git reset --hard HEAD
+              RESULTS="${RESULTS}${PR_NUMBER}=❌ "
+              FAILED=true
+              break
+            fi
           done
 
+          echo "results=${RESULTS}" >> "$GITHUB_OUTPUT"
+
+          if [ "$FAILED" = "true" ]; then
+            exit 1
+          fi
+
       - name: Push backport branch
         env:
           STEPS_BACKPORT_BRANCH_OUTPUTS_NAME: ${{ steps.backport-branch.outputs.name }}
         run: git push -u origin "${STEPS_BACKPORT_BRANCH_OUTPUTS_NAME}"
 
       - name: Create pull request
+        id: create-pr
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           STEPS_UPSTREAM_OUTPUTS_REPO: ${{ steps.upstream.outputs.repo }}
@@ -291,3 +312,43 @@ jobs:
           else
             echo "::notice::The 'Auto-backport' label does not exist on ${PR_REPO}. Consider adding it so that backport pull requests can be identified easily."
           fi
+
+          echo "url=${PR_URL}" >> "$GITHUB_OUTPUT"
+
+      - name: Write job summary
+        if: always()
+        env:
+          MATRIX_BRANCH: ${{ matrix.branch }}
+          INPUTS_COMMIT_SHA: ${{ inputs.commit-sha }}
+          INPUTS_PR_NUMBERS: ${{ inputs.pr_numbers }}
+          STEPS_MERGE_PRS_OUTPUTS_RESULTS: ${{ steps.merge-prs.outputs.results }}
+          STEPS_CREATE_PR_OUTPUTS_URL: ${{ steps.create-pr.outputs.url }}
+        run: |
+          PR_DISPLAY="${STEPS_CREATE_PR_OUTPUTS_URL:-N/A}"
+
+          if [ -n "${INPUTS_PR_NUMBERS}" ] && [ -z "${INPUTS_COMMIT_SHA}" ]; then
+            IFS=',' read -ra PR_LIST <<< "${INPUTS_PR_NUMBERS}"
+
+            HEADER="| Branch |"
+            SEPARATOR="| :--- |"
+            for PR_NUM in "${PR_LIST[@]}"; do
+              PR_NUM=$(echo "$PR_NUM" | tr -d ' ')
+              HEADER="${HEADER} #${PR_NUM} |"
+              SEPARATOR="${SEPARATOR} :---: |"
+            done
+            HEADER="${HEADER} Pull Request |"
+            SEPARATOR="${SEPARATOR} :--- |"
+
+            ROW="| \`${MATRIX_BRANCH}\` |"
+            for PR_NUM in "${PR_LIST[@]}"; do
+              PR_NUM=$(echo "$PR_NUM" | tr -d ' ')
+              STATUS=$(echo "${STEPS_MERGE_PRS_OUTPUTS_RESULTS}" | tr ' ' '\n' | grep "^${PR_NUM}=" | cut -d= -f2)
+              ROW="${ROW} ${STATUS:-❌} |"
+            done
+            ROW="${ROW} ${PR_DISPLAY} |"
+
+            printf '%s\n%s\n%s\n' "$HEADER" "$SEPARATOR" "$ROW" >> "$GITHUB_STEP_SUMMARY"
+          else
+            printf '| Branch | Pull Request |\n| :--- | :--- |\n| `%s` | %s |\n' \
+              "${MATRIX_BRANCH}" "${PR_DISPLAY}" >> "$GITHUB_STEP_SUMMARY"
+          fi