Quickstart

🚀 Overview

This guide introduces the key workflows you’ll use in Unity-CI-Templates.

---

🚀 Getting Started

1️⃣ Ensure your Unity project is in a GitHub repository
2️⃣ Copy the required GitHub Actions workflows from the CICD_Workflows folder
3️⃣ Add them to your repository at path: .github → workflows (create folders if missing)
4️⃣ Configure the required secrets in your repository
5️⃣ Read and optionally setup repository variables, they're important to understand the inputs for the workflow dispatch
6️⃣ Try dispatching the ci-cd-dispatcher.yml workflow or push a Git tag using SemVer to see the pipeline in action!

---

🚀 Main Workflows

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	Modular workflow_call templates for each stage

---

🚀 The Five CI/CD Steps

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

---

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