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