https://github.com/buildalon/activate-unity-license
A GitHub Action to activate a Unity Game Engine license for CI/CD workflows
https://github.com/buildalon/activate-unity-license
action activate-unity-license automation buildalon cd ci ci-cd game-ci github-actions license-checking license-management unity unity-license unity3d
Last synced: 2 days ago
JSON representation
A GitHub Action to activate a Unity Game Engine license for CI/CD workflows
- Host: GitHub
- URL: https://github.com/buildalon/activate-unity-license
- Owner: buildalon
- License: mit
- Created: 2024-08-07T15:49:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-23T14:40:18.000Z (about 1 year ago)
- Last Synced: 2024-09-27T23:01:12.367Z (about 1 year ago)
- Topics: action, activate-unity-license, automation, buildalon, cd, ci, ci-cd, game-ci, github-actions, license-checking, license-management, unity, unity-license, unity3d
- Language: TypeScript
- Homepage: https://buildalon.com
- Size: 141 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Buildalon Activate Unity License
[](https://discord.gg/VM9cWJ9rjH) [](https://github.com/marketplace?query=buildalon) [](https://github.com/buildalon/activate-unity-license/actions/workflows/validate.yml)
A GitHub Action to activate a [Unity Game Engine](https://unity.com) license for CI/CD workflows.
## How to use
This action uses your stored environment secrets to authenticate with the Unity Licensing servers.
***It's important that you disable other forks of your repository to run actions in pull requests from unknown contributors.***
> Read more on [Approving workflow runs from public forks](
https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)
[](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)
### inputs
This action requires several secrets that need to be setup in the repository or organization's action secret store.
* `UNITY_USERNAME`: The ***email address*** you use for your Unity Id.
* `UNITY_PASSWORD`: The ***password*** you use for Unity Id access.
* `UNITY_SERIAL`: The ***Serial number*** for the seat.
* `UNITY_SERVICES_CONFIG`: Unity License Client `services-config.json` encoded as base64 string.
> [!IMPORTANT]
> Don't forget that Professional licenses only support 2 activations at a time!
| name | description | required |
| ---- | ----------- | -------- |
| `license` | Must be one of `personal`, `professional`, or `floating`. | Defaults to `personal` |
| `username` | The ***email address*** you use for your Unity Id | Required for `personal`, `professional` license activations |
| `password` | The ***password*** you use for Unity Id access | Required for `personal` and `professional` license activations |
| `serial` | The ***Serial number*** for the seat | Required for `professional` license activations, but not named seats. |
| `configuration` | Unity License Client `services-config.json` encoded as base64 string | Required for `floating` license activations |
| `license-version` | Must be one of `4.x` (Unity 4.x), `5.x` (Unity 5.x), `6.x` (Unity 2017+) | Defaults to `6.x` |
### workflow
```yaml
steps:
- uses: buildalon/activate-unity-license@v2
with:
license: 'Personal' # Choose license type to use [ Personal, Professional, Floating ]
username: ${{ secrets.UNITY_USERNAME }}
password: ${{ secrets.UNITY_PASSWORD }}
# serial: ${{ secrets.UNITY_SERIAL }} # Required for pro activations
# configuration: ${{ secrets.UNITY_SERVICES_CONFIG }} # Required for floating license activations
# license-version: '6.x' # Optional, defaults to '6.x', can be set to '5.x' for Unity 5.x licenses
```