-
Notifications
You must be signed in to change notification settings - Fork 8
Quickstart
Astrid Avalin Soerensen edited this page May 9, 2025
·
16 revisions
The most important workflows for you to get to know:
1οΈβ£ Make sure your Unity project is in a GitHub repository
2οΈβ£ Copy the required GitHub Actions workflows from the CICD_Workflows folder
2οΈβ£ Add it to your repository at path: .github β workflows (create folders if they're missing)
3οΈβ£ Configure the needed secrets and variables
4οΈβ£ Review the wiki pages here to understand the versioning, deployment, and customization options
| Stage | Purpose |
|---|---|
| Dispatcher | Entry point for triggering builds, from manual or auto triggers |
| CI/CD Pipeline | Main workflow that handles test, build, release, deploy, notify |
| Redeployer | Redeploy artifacts from an existing GitHub Release |
| Step Workflows | Modular workflow_call templates for each stage |
This system is split into five main stages:
| Step | What it does |
|---|---|
| π Step 1 - Test | Runs EditMode + PlayMode Unity tests and summarizes results |
| π§© Step 2 - Build | Builds Unity project for multiple platforms (matrixed) |
| π¦ Step 3 - Release | Uploads artifacts to GitHub Releases (if release-type) |
| π Step 4 - Deploy | Deploys to targets like GitHub Pages, itch.io, Firebase, S3, Steam |
| π£ Step 5 - Notify | Sends notifications to Slack, Discord, and writes summaries |
Letβs build better Unity pipelines together! π
Need help? Join the Discussions or open an Issue.