https://github.com/avalin/unity-ci-templates

Unity CI/CD pipeline with multi-platform builds, releases, and deploys
https://github.com/avalin/unity-ci-templates

build-pipelines ci-cd cicd deployment deployments game-dev game-development github-actions unity unity2d unity3d

Last synced: about 2 months ago
JSON representation

Unity CI/CD pipeline with multi-platform builds, releases, and deploys

• Host: GitHub
• URL: https://github.com/avalin/unity-ci-templates
• Owner: Avalin
• License: mit
• Created: 2025-03-30T13:13:18.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-05-08T15:20:36.000Z (about 2 months ago)
• Last Synced: 2025-05-08T15:25:46.048Z (about 2 months ago)
• Topics: build-pipelines, ci-cd, cicd, deployment, deployments, game-dev, game-development, github-actions, unity, unity2d, unity3d
• Language: ShaderLab
• Homepage: https://avalin.dk/Unity-CI-Templates/
• Size: 17 MB
• Stars: 37
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚀 Unity CI/CD Pipeline

**Robust GitHub Actions workflows for Unity projects. Automates testing, multi-platform builds, and GitHub Releases with modular, reusable design.**

![CI](https://github.com/Avalin/CI-CD-Unity-Test-Project/actions/workflows/ci-cd-pipeline.yml/badge.svg)

![License](https://img.shields.io/github/license/Avalin/CI-CD-Unity-Test-Project?color=blue)

![Unity](https://img.shields.io/badge/unity-2022.3%2B-black?logo=unity)

![Latest Release](https://img.shields.io/github/v/release/Avalin/Unity-CI-Templates)

## 🌐 WebGL Demo

See a live WebGL build deployed using this CI/CD pipeline:

➡️ [**Play the Demo**](https://avalin.github.io/Unity-CI-Templates/)

> Deployed via GitHub Pages using the `gh-pages` deploy target.

## 🚀 Getting Started

1️⃣ Ensure your Unity project is in a GitHub repository  

2️⃣ Copy the required GitHub Actions workflows from the [CICD_Workflows folder](https://github.com/Avalin/Unity-CI-Templates/tree/main/CICD_Workflows)  

3️⃣ Add them to your repository at path: **.github → workflows** _(create folders if missing)_


4️⃣ Configure the [required secrets](https://github.com/Avalin/Unity-CI-Templates/wiki/Required-Secrets) in your repository


5️⃣ Read and optionally setup [repository variables](https://github.com/Avalin/Unity-CI-Templates/wiki/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](https://github.com/Avalin/Unity-CI-Templates/wiki/Versioning-&-Tagging) to see the pipeline in action! 


> ⚠️ Currently tested deploy targets: `gh-pages` (WebGL only). Others are implemented but not yet fully verified. Contributions welcome!

## 📖 Documentation

For full setup instructions, deployment target guides, and advanced configuration tips, see the ➡️ [Wiki](https://github.com/Avalin/Unity-CI-Templates/wiki)

## 📌 Features

| Feature                        | Description |

|-------------------------------|-------------|

| 🧪 **Test Detection**            | Auto-detects and runs EditMode & PlayMode tests. |

| 🛠️ **Cross-Platform Builds**     | Android, iOS, WebGL, macOS, Windows, and Linux supported. |

| 📦 **Release Deployment**        | Automatically creates GitHub Releases on tag push. |

| 🧹 **Modular Design**            | Fully split into reusable `workflow_call` templates. |

| ⚡ **Parallel Matrix Builds**     | Parallel jobs across macOS and Ubuntu runners. |

| 🔐 **Secure License Activation** | Unity `.ulf` license securely injected during CI. |

| 🗃️ **LFS & Cache**               | Optional Git LFS + caching of Unity `Library` and `Packages/`. |

| 🎛️ **Manual Dispatch**          | Manually trigger preview builds with JSON platform control. |

| 🚀 **Deploy**                | Upload builds to external platforms like itch.io, TestFlight, or custom servers |

| 📣 **Notifications**         | Discord/Slack webhook support |

| 🔍 **Static Analysis**       | C# linters or Unity analyzers |

## ⚠ Current Limitations

While the pipeline is production-ready and modular, some deploy integrations are still marked as **experimental**:

- 🚧 **Deploy targets like Steam, TestFlight, App Center**  

  These are implemented but have not yet been fully validated in live release pipelines.

- 🔗 **External platforms may require manual setup**  

  Some targets (like itch.io, Firebase, S3) require correctly configured secrets and accounts - be sure to test deploy flows in a safe sandbox environment before pushing to production.

- 🧪 **Unity version compatibility**  

  Currently optimized for Unity 2022.3+, tested with Unity 6 too, but older versions may work as well.

> **Contributions and testing feedback are welcome!**  

> If you successfully validate additional targets or add new ones, please consider opening a PR to improve support for the community.

---

## 🙌 Credits

Crafted with ❤️ by [Avalin](https://github.com/Avalin)  

Powered by GitHub Actions + Unity + Tears.

(PRs welcome!)