Notifications - Avalin/Unity-CI-CD GitHub Wiki
π£ 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
π 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
-
Create a webhook
- For Slack β use an Incoming Webhook URL
- For Discord β create a webhook in your Discord server
-
Add the secret to your GitHub repo
SLACK_WEBHOOKβ for SlackDISCORD_WEBHOOKβ for Discord
-
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!