Quickstart

🚀 Overview

The most important workflows for you to get to know:

🚀 Getting Started

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

🚀 Main Workflows

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

🚀 The Five CI/CD Steps

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

📐 Architecture Overview

[ 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)