Home

🏠 Welcome to the Unity-CI-Templates Wiki!

This wiki provides documentation for using and configuring the Unity CI/CD Templates.
A modular, production-ready GitHub Actions pipeline for Unity projects.

---

📚 What’s Inside

• Required Secrets → List of necessary secrets (like UNITY_LICENSE, CICD_PAT) and how to set them up
• Required Variables → Configurable inputs and variables for customizing pipeline behavior (Optional)
• Deployment → Step-by-step guide for deploying to supported platforms (GitHub Pages, itch.io, Firebase, etc.)
• Versioning & Tagging → Explanation of the automated versioning, tagging, and release management system

---

🏗️ What Is This?

The Unity CI/CD Templates provide:

✅ Automated builds and tests for Unity projects
✅ Multi-platform artifact handling
✅ Release and deployment automation
✅ Integration with Slack & Discord for notifications

It’s designed to work out of the box, but is fully modular and customizable for advanced setups.

---

🚀 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

---

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

## 💬 Need Help?

If you encounter issues or want to contribute improvements, open an issue or pull request in the main repository.

Let’s build better Unity pipelines together!