chore: beautify the slack message for the sync to pg workflow message

[AnaghHegde]

Summary by CodeRabbit

• Improvements
  • Enhanced handling of merge conflicts during the release process.
  • Added conditional notifications for merge conflicts to improve communication.
  • Streamlined the workflow for pushing changes to the pg branch based on conflict detection.

[coderabbitai]

Walkthrough

The pull request modifies the GitHub workflow file .github/workflows/sync-release-to-pg.yml to improve the handling of merge conflicts when merging the release branch into the pg branch. Key updates include enhanced detection of merge conflicts, the introduction of environment variables to indicate conflict status, conditional execution of the push step based on conflict presence, and adjustments to the Slack notification message regarding merge conflicts.

Changes

File	Change Summary
.github/workflows/sync-release-to-pg.yml	- Added detection for merge conflicts by capturing the SHA of the conflicting commit. - Introduced MERGE_CONFLICT environment variable to indicate conflict status. - Made the push step conditional based on the MERGE_CONFLICT variable. - Adjusted Slack notification message formatting to remove newline at the end of the conflicting commit URL.

Possibly related PRs

• chore: update the channel id for the postgres conflict alerts #36554: This PR modifies the Slack notification channel for PostgreSQL conflict alerts, which is directly related to the main PR's enhancements in handling merge conflicts and notifications in the .github/workflows/sync-release-to-pg.yml file.

Suggested labels

skip-changelog

Suggested reviewers

• abhvsn

Poem

In workflows where conflicts arise,
A new detection now underlies.
With pushes that wait for a clear sign,
And Slack alerts that now align.
Merge with ease, let chaos cease,
In harmony, let code release! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

.github/workflows/sync-release-to-pg.yml (3)

62-64: Consider enhancing the Slack notification message format.

While the message construction is cleaner now, it could be more informative for developers.

Consider this enhanced format:

-          message="Merge conflict detected while merging release into pg branch. Conflicted commits:"
-          commit_url="$REPOSITORY_URL/commit/$CONFLICTING_COMMIT"
-          message+="$commit_url"
+          message="🚨 Merge Conflict Alert: release → pg branch"
+          message+="\n• Conflicting Commit: $REPOSITORY_URL/commit/$CONFLICTING_COMMIT"
+          message+="\n• Action Required: Manual resolution needed"

---

Line range hint 82-84: Fix the Slack token interpolation in curl command.

The single quotes around the token prevent variable expansion.

Apply this fix:

           curl -v https://slack.com/api/chat.postMessage \
-            --header 'Authorization: Bearer ${{ secrets.SLACK_APPSMITH_ALERTS_TOKEN }}' \
+            --header "Authorization: Bearer ${{ secrets.SLACK_APPSMITH_ALERTS_TOKEN }}" \
             --header 'Content-Type: application/json; charset=utf-8' \

---

Line range hint 1-85: Consider adding timeout to prevent workflow hanging.

Long-running merge operations could potentially hang. Adding a timeout would ensure the workflow fails gracefully.

Add this at the job level:

   merge-release-to-pg:
     runs-on: ubuntu-latest
+    timeout-minutes: 10

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5c075e8 and a354f46.

📒 Files selected for processing (1)

• .github/workflows/sync-release-to-pg.yml (1 hunks)