https://github.com/2004seraph/cyanci-for-unity

A basic self-hosted CI solution for small-scale Unity projects. It will watch a GitHub repo and build on certain commits
https://github.com/2004seraph/cyanci-for-unity

ci self-hosted unity unity-tool

Last synced: about 2 months ago
JSON representation

A basic self-hosted CI solution for small-scale Unity projects. It will watch a GitHub repo and build on certain commits

• Host: GitHub
• URL: https://github.com/2004seraph/cyanci-for-unity
• Owner: 2004seraph
• License: agpl-3.0
• Created: 2023-02-07T22:05:03.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-05T19:17:13.000Z (11 months ago)
• Last Synced: 2024-04-21T11:48:10.719Z (9 months ago)
• Topics: ci, self-hosted, unity, unity-tool
• Language: C#
• Homepage:
• Size: 39.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Self-Hosted Unity CI

A bare-bones self-hosted CI solution integrating GitHub and Unity.

 

# For Server

## Prerequisites

 - NodeJS.

 

 - Git.

 - You must install your project's Unity version somewhere on your server.

 - You must clone your project's repo somewhere on your server.

## Setup

Edit the `settings.ini` file, here you will enter the path to your local repo clone, as well as where you want the builds to be placed (this could be your FTP server). These settings can be edited whilst the server is running, since they are fetched from the file every time they are needed.

Run INSTALL.ps1 and locate your desired Unity editor EXE version (it will be set as an envar), then run START.bat to run the application.

It will continuously poll the GitHub commits RSS feed for the desired repository and then run a build when a commit is titled `[Build]`.

## Info

The server will keep a log of all of it's actions in a file called `CyanCIServer.log`, this is located within the `Server` directory.

# For Client

## Setup

There are no prerequisites or setup for clients, except you must install the unity package located within this repo (`software.contraband.cyanci`, and you must install it by copying the directory to your project's `Packages/` folder) before the CI can work, this contains the build functionality invoked by the server.

## Usage

Whenever you need the project to be built, title a commit with `[Build]` (it is case-insensitive).