How to maintain the CI (GitHub workflows)

GitHub Workflows allows to run certain commands, e.g. for Pull Requests. We currently test whether the PR builds successfully. Here is how to set this up.

The workflows scripts (configuration files) can be found under "repo_root".github/workflows/*.yml

1 Check you have set the correct Unity versions

Check the workflow scripts for mentions of the Unity version to use and update it to what is used currently.

2 Run the activate.yml workflow

When opening a PR, the workflows should run automatically. Open the Activation workflow and download the saved Activation .alf file, which should have been stored as a build artifact after execution.

3 Acquire the corresponding .ulf file

Got to Unity here: [https://license.unity3d.com/manual]() Upload the .alf and get the .ulf. Both should be named after the Unity version you are using.

4 Upload the content of the .ulf as UNITY_LICENSE secret

Set up or update the GitHub secret "UNITY_LICENSE" with all the contents of the .ulf. Secrets can be found in the repository settings.

5 Run the build workflow

Now the build workflow (buildMaster.yml) should build successfully using the uploaded license!

Troubleshootings

We hope the storage space is sufficient, but it may happen you have to change the settings in the "Remove artifacts" step to remove more old artifacts.