Skip to content

Notifications

Astrid Avalin Soerensen edited this page May 9, 2025 · 3 revisions

๐Ÿ“ฃ Notifications

The Unity CI/CD Templates support optional notifications to Slack and Discord using webhooks.
When configured, the pipeline sends detailed messages after each run to keep your team informed.


๐Ÿ“ท Example Notifications

Hereโ€™s an example of a Slack notification showing:

  • โœ… Release succeeded
  • โŒ Deploy failed on a specific target
  • Commit info, release link, and pipeline link
  • A per-target deployment summary table

Slack Notification Example


๐Ÿ”” Whatโ€™s Included?

The notification includes:

  • Tests status โ†’ failure notification on release and RC builds
  • Release status โ†’ success, failure, or partial (release ok but deploy failed)
  • Deploy target summary โ†’ table showing each target (e.g., gh-pages, itch.io) with โœ… or โŒ
  • Commit + branch details โ†’ commit hash, branch, and version
  • Quick links โ†’ to the GitHub Release page and the pipeline run

๐Ÿ›  Supported Platforms

Platform Status Setup Requirement
Slack โœ… Supported Add SLACK_WEBHOOK secret
Discord โœ… Supported Add DISCORD_WEBHOOK secret
Microsoft Teams โš  Planned Not yet implemented (see roadmap)

โš™๏ธ How to Set Up

  1. Create a webhook

    • For Slack โ†’ use an Incoming Webhook URL
    • For Discord โ†’ create a webhook in your Discord server
  2. Add the secret to your GitHub repo

    • SLACK_WEBHOOK โ†’ for Slack
    • DISCORD_WEBHOOK โ†’ for Discord
  3. Thatโ€™s it!
    If the secrets exist, the pipeline will automatically send notifications after release and deployment.


๐Ÿงฉ Customization

Want to customize the message formatting?

  • Slack messages โ†’ use colored attachments (good, danger, or neutral)
  • Discord messages โ†’ simple markdown text

Advanced users can modify:

  • .github/actions/generate-notification
  • Workflow files in .github/workflows/step-5-notify.yml

We welcome PRs to improve or extend platform support!


๐Ÿ— Planned Improvements

  • Microsoft Teams integration
  • Email notifications (optional)

Check the Roadmap or open a Discussion if you want to contribute!


๐Ÿ”— Related Pages

Clone this wiki locally