GHA-210 Send release summary to the Slack channel. (#117)

tomasz-tylenda-sonarsource · nils-werner-sonarsource · web-flow · commit 69548c4b30aa · 2026-03-13T14:38:04.000+01:00
Co-authored-by: Nils Werner &lt;64034005+nils-werner-sonarsource@users.noreply.github.com&gt;
diff --git a/.github/workflows/automated-release.yml b/.github/workflows/automated-release.yml
@@ -698,7 +698,7 @@ jobs:
   # This step summarizes the results of the entire release process.
   # It checks the outcomes of all previous steps and generates a summary indicating whether the release was
   # successful or failed, along with relevant links and information.
-  summarize_release:
+  summarize-release:
     name: Release Results
     runs-on: ${{ inputs.runner-environment }}
     if: always()
@@ -714,11 +714,14 @@ jobs:
       - create-integration-tickets
       - update-analyzers
     env:
-        RELEASE_PROCESS: ${{ inputs.release-process != '' && inputs.release-process || 'https://xtranet-sonarsource.atlassian.net/wiki/spaces/CSD/pages/4325048388/Release+Instructions+-+Cloud+Security' }}
+        RELEASE_PROCESS: ${{ inputs.release-process }}
     steps:
-      - name: Post Summary to Workflow
+
+      - name: Create Message
+        id: create-message
         shell: bash
         env:
+          PROJECT_NAME: ${{ inputs.project-name }}
           RELEASE_VERSION: ${{ needs.prepare-release.outputs.release-version }}
           NEW_VERSION: ${{ needs.release-in-jira.outputs.new-version || 'not created' }}
           JIRA_RELEASE_URL: ${{ needs.prepare-release.outputs.jira-release-url || 'not resolved' }}
@@ -734,44 +737,68 @@ jobs:
           RESULT_PUBLISH_GITHUB_RELEASE: ${{ needs.publish-github-release.result }}
           RESULT_CREATE_RELEASE_TICKET: ${{ needs.create-release-ticket.result }}
           RESULT_RELEASE_IN_JIRA: ${{ needs.release-in-jira.result }}
+          RESULT_BUMP_VERSION: ${{ needs.bump-version.result }}
           RESULT_CREATE_INTEGRATION_TICKETS: ${{ needs.create-integration-tickets.result }}
           RESULT_UPDATE_ANALYZERS: ${{ needs.update-analyzers.result }}
         run: |
           ALL_SUCCESS=true
-          for result in "$RESULT_CHECK_RELEASABILITY" "$RESULT_PREPARE_RELEASE" "$RESULT_PUBLISH_GITHUB_RELEASE" "$RESULT_CREATE_RELEASE_TICKET" "$RESULT_RELEASE_IN_JIRA" "$RESULT_CREATE_INTEGRATION_TICKETS" "$RESULT_UPDATE_ANALYZERS"; do
+          for result in "$RESULT_CHECK_RELEASABILITY" "$RESULT_PREPARE_RELEASE" "$RESULT_PUBLISH_GITHUB_RELEASE" "$RESULT_CREATE_RELEASE_TICKET" "$RESULT_RELEASE_IN_JIRA" "$RESULT_CREATE_INTEGRATION_TICKETS" "$RESULT_UPDATE_ANALYZERS" "$RESULT_BUMP_VERSION"; do
             if [[ "$result" != "success" && "$result" != "skipped" ]]; then
               ALL_SUCCESS=false
               break
             fi
           done
-          
-          if [[ "$ALL_SUCCESS" == "true" ]]; then
-            echo "# 🎉 Release Successful" >> $GITHUB_STEP_SUMMARY
-            echo "The automated release completed without errors. Below is a consolidated overview of the run." >> $GITHUB_STEP_SUMMARY
-          else
-            echo "# ❌ Release Failed" >> $GITHUB_STEP_SUMMARY
-            echo "One or more jobs failed. Review the job logs and links below." >> $GITHUB_STEP_SUMMARY
-          fi
-          echo "" >> $GITHUB_STEP_SUMMARY
 
-          cat <<EOF >> $GITHUB_STEP_SUMMARY
-          - Released Version: \`$RELEASE_VERSION\`
-          - New Version: \`$NEW_VERSION\`
-          - Jira Release: $JIRA_RELEASE_URL
-          - Release Ticket: $RELEASE_TICKET_URL
-          - GitHub Release: $GITHUB_RELEASE_URL
-          - SQS Integration Ticket: $SQS_TICKET_URL
-          - SQC Integration Ticket: $SQC_TICKET_URL
-          - SQS Analyzer PR: $SQS_PR_URL
-          - SQC Analyzer PR: $SQC_PR_URL
-          - Bump Version PR: $BUMP_VERSION_PR_URL
-          EOF
-
-          echo "## Guidance" >> $GITHUB_STEP_SUMMARY
-          if [[ "$ALL_SUCCESS" == "true" ]]; then
-            echo "- Review and merge the bump version, SQS and SQC PRs." >> $GITHUB_STEP_SUMMARY
-            echo "- Update integration ticket statuses (ensure SQS ticket fix versions are set)." >> $GITHUB_STEP_SUMMARY
-          else
-            echo "- Check failed jobs for error messages and re-run as needed." >> $GITHUB_STEP_SUMMARY
-          fi
-          echo "- Reference: $RELEASE_PROCESS" >> $GITHUB_STEP_SUMMARY
+          {
+            echo "message<<ENDOFMESSAGE"
+
+            if [[ "$USE_JIRA_SANDBOX" == "true" ]]; then
+              echo "# DRY RUN (NOT A REAL RELEASE)"
+            fi
+
+            if [[ "$ALL_SUCCESS" == "true" ]]; then
+              echo "# 🎉 ${PROJECT_NAME}: Release Successful"
+              echo "The automated release completed without errors. Below is a consolidated overview of the run."
+            else
+              echo "# ❌ ${PROJECT_NAME}: Release Failed"
+              echo "One or more jobs failed. Review the job logs and links below."
+            fi
+            echo ""
+
+            echo "  - Released Version: \`$RELEASE_VERSION\`"
+            echo "  - Next Iteration Version: \`$NEW_VERSION\`"
+            echo "  - Jira Release: $JIRA_RELEASE_URL"
+            echo "  - Release Ticket: $RELEASE_TICKET_URL"
+            echo "  - GitHub Release: $GITHUB_RELEASE_URL"
+            echo "  - GitHub Action Run: ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
+            echo "  - SQS Integration Ticket: $SQS_TICKET_URL"
+            echo "  - SQC Integration Ticket: $SQC_TICKET_URL"
+            echo "  - SQS Analyzer PR: $SQS_PR_URL"
+            echo "  - SQC Analyzer PR: $SQC_PR_URL"
+            echo "  - Bump Version PR: $BUMP_VERSION_PR_URL"
+
+            echo "## Guidance"
+            if [[ "$ALL_SUCCESS" == "true" ]]; then
+              echo "- Review and merge the bump version, SQS and SQC PRs."
+              echo "- Update integration ticket statuses (ensure SQS ticket fix versions are set)."
+            else
+              echo "- Check failed jobs for error messages and re-run as needed."
+            fi
+            echo "- Reference: $RELEASE_PROCESS"
+            echo "ENDOFMESSAGE"
+          } >> $GITHUB_OUTPUT
+
+      - name: Post Summary to Workflow
+        id: summary
+        shell: bash
+        env:
+          MESSAGE: ${{ steps.create-message.outputs.message }}
+        run: |
+          echo "${MESSAGE}" >> $GITHUB_STEP_SUMMARY
+
+      - name: Post Summary to Slack
+        if: ${{ inputs.slack-channel != '' }}
+        uses: SonarSource/release-github-actions/slack-message@v1
+        with:
+          channel: ${{ inputs.slack-channel }}
+          message-markdown: ${{ steps.create-message.outputs.message }}
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ A centralized collection of reusable GitHub Actions designed to streamline and a
 | [Get Release Version](get-release-version/README.md)                    | Extracts the release version from the repox status on a specified branch |
 | [Lock Branch](lock-branch/README.md)                                    | Locks or unlocks a branch by modifying the `lock_branch` setting in branch protection rules |
 | [Notify Slack on Failure](notify-slack/README.md)                       | Sends a Slack notification when a job fails |
+| [Send Slack Message](slack-message/README.md)                           | Sends a markdown message to a Slack channel |
 | [Publish GitHub Release](publish-github-release/README.md)              | Publishes a GitHub Release with notes fetched from Jira or provided directly |
 | [Release Jira Version](release-jira-version/README.md)                  | Releases a Jira version and creates the next one |
 | [Sonar Update Center Release](sonar-update-center-release/README.md)    | Updates a plugin entry in sonar-update-center-properties and creates a pull request |
diff --git a/slack-message/README.md b/slack-message/README.md
@@ -0,0 +1,19 @@
+# Send Slack Message Action
+
+Sends a markdown message to a Slack channel.
+
+Unlike `rtCamp/action-slack-notify`, this action uses `slackapi/slack-github-action` and does not require Docker.
+
+## Inputs
+
+| Input              | Description                                           | Required |
+|--------------------|-------------------------------------------------------|----------|
+| `channel`          | Slack channel (without `#`) to post the message into. | Yes      |
+| `message-markdown` | The message to send, in markdown format.              | Yes      |
+
+## Implementation Details
+
+This action depends on:
+
+- [LoveToKnow/slackify-markdown-action](https://github.com/LoveToKnow/slackify-markdown-action) to convert markdown to Slack's mrkdwn format
+- [slackapi/slack-github-action](https://github.com/slackapi/slack-github-action) to send the message via `chat.postMessage`
diff --git a/slack-message/action.yml b/slack-message/action.yml
@@ -0,0 +1,43 @@
+name: 'Send Slack Message'
+description: 'Sends a markdown message to a Slack channel.'
+
+inputs:
+  channel:
+    description: 'The Slack channel to send the message to (without #).'
+    required: true
+  message-markdown:
+    description: 'The message to send, in markdown format.'
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Vault Secrets
+      id: secrets
+      uses: SonarSource/vault-action-wrapper@v3
+      with:
+        secrets: |
+          development/kv/data/slack token | SLACK_TOKEN;
+
+    - name: Convert Markdown to Slack
+      id: slackify
+      uses: LoveToKnow/slackify-markdown-action@698a1d4d0ff1794152a93c03ee8ca5e03a310d4e # v1.1.1
+      with:
+        text: ${{ inputs.message-markdown }}
+
+    - name: Build Payload
+      id: payload
+      shell: bash
+      env:
+        CHANNEL: ${{ inputs.channel }}
+        MESSAGE: ${{ steps.slackify.outputs.text }}
+      run: |
+        PAYLOAD=$(jq -cn --arg channel "$CHANNEL" --arg text "$MESSAGE" '{channel: $channel, text: $text}')
+        echo "json=$PAYLOAD" >> $GITHUB_OUTPUT
+
+    - name: Send Slack Message
+      uses: slackapi/slack-github-action@91efab103c0de0a537f72a35f6b8cda0ee76bf0a # v2.1.1
+      with:
+        method: chat.postMessage
+        token: ${{ fromJSON(steps.secrets.outputs.vault).SLACK_TOKEN }}
+        payload: ${{ steps.payload.outputs.json }}
