Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.77 KB

CI.md

File metadata and controls

30 lines (21 loc) · 1.77 KB

Continuous Integration

This project uses GameCI for building and testing the unity project. The full workflow file can be found here.

Build and Test

The first thing you need is a license file. For this project we use a free personal license. To obtain this file you should follow the guide. If the file does not exist follow the "activate your personal license" step even though you already have a license.

We make use of NuGetForUnity which requires NuGet packages to be restored before building the project. This is done in the setup step.

Linting

This step does not use GameCI and thus requires more setup to work. First you should grab the license key from the license file (which is actually an XML file). Do this by opening it in a text editor. Copy the base64 encoded data in the Value attribute in the DeveloperData element. Decode this base64 encoded data and remove the first 4 bytes (garbage). It should match the value in the SerialMasked element (except for the last 4 XXXXs). Add this to GitHub secrets as UNITY_SERIAL.

The lint step requires that the "JetBrains Rider Editor" package is installed in the Unity Project. It is used to generate the project and solution files needed for dotnet to run on the c# code. We exclude some directories from being linted as they are either generated code or external library code.