Continuous integration (GitHub Actions)
Continuous integration (GitHub Actions)
Workflows live in .github/workflows/ at the git repository root (alongside the First Principles/ Unity project folder).
| Workflow | When it runs | Secrets |
|---|---|---|
Documentation (docs.yml) |
Push/PR touching docs/** |
None — runs bundle exec jekyll build. |
Unity (unity.yml) |
Push/PR touching First Principles/** |
UNITY_LICENSE (see below). |
Unity license for CI
The Unity job uses GameCI’s unity-test-runner. You must add a repository secret:
- Follow the official activation guide: GameCI — Unity Activation.
- In GitHub: Settings → Secrets and variables → Actions → New repository secret
- Name:
UNITY_LICENSE - Value: the license content as documented by GameCI (often the Base64-encoded license file for your Unity seat).
- Name:
Until UNITY_LICENSE is set, the Unity workflow will fail on the test step — the documentation workflow will still pass.
Local checks
- Docs:
cd docs && bundle install && bundle exec jekyll serve - Unity: open the
First Principlesfolder in Unity 6000.4.0f1 (seeProjectSettings/ProjectVersion.txt).
Optional: Play Mode tests
If you add Play Mode tests later, extend .github/workflows/unity.yml with a second job (or matrix entry) using testMode: playmode.
Maintainers: keep unityVersion in unity.yml aligned with First Principles/ProjectSettings/ProjectVersion.txt.