- Notifications
You must be signed in to change notification settings - Fork6
Quickstart
Astrid Avalin Soerensen edited this pageMay 12, 2025 ·16 revisions
This guide introduces the key workflows you’ll use in Unity-CI-Templates.
1️⃣ Ensure your Unity project is in a GitHub repository
2️⃣ Copy the required GitHub Actions workflows from theCICD_Workflows folder
3️⃣ Add them to your repository at path:.github → workflows(create folders if missing)
4️⃣ Configure therequired secrets in your repository
5️⃣ Read and optionally setuprepository variables, they're important to understand the inputs for the workflow dispatch
6️⃣ Try dispatching theci-cd-dispatcher.yml workflow or push a Git tag usingSemVer to see the pipeline in action!
| Stage | Purpose |
|---|---|
| Dispatcher | Entry point for triggering builds (manual or auto triggers) |
| CI/CD Pipeline | Main workflow that runs tests, builds, releases, deploys, notifies |
| Redeployer | Redeploys artifacts from an existing GitHub Release |
| Step Workflows | Modularworkflow_call templates for each stage |
| Step | What it does |
|---|---|
| 📋 Step 1 - Test | Runs EditMode + PlayMode Unity tests and summarizes results |
| 🧩 Step 2 - Build | Builds Unity project for multiple platforms (matrix builds) |
| 📦 Step 3 - Release | Uploads artifacts to GitHub Releases (if using 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 |
[ Dispatcher ] ↓[ Metadata Preparation ] ↓[ CI/CD Pipeline ] ├── 🧪 Tests (EditMode + PlayMode) ├── 🛠️ Build (matrix by platform) ├── 📦 Release (GitHub Releases for tags/RCs) ├── 🌍 Deploy (gh-pages, itch.io, etc.) └── 🔔 Notify (Discord, Slack)Let’s build better Unity pipelines together! 🚀
Need help? Join theDiscussions or open anIssue.