https://github.com/rageagainstthepixel/activate-unity-license

A GitHub Action to activate a Unity Game Engine license for CI/CD workflows
https://github.com/rageagainstthepixel/activate-unity-license

actions cd ci ci-cd github-action license-management unity unity3d

Last synced: about 1 month ago
JSON representation

A GitHub Action to activate a Unity Game Engine license for CI/CD workflows

• Host: GitHub
• URL: https://github.com/rageagainstthepixel/activate-unity-license
• Owner: RageAgainstThePixel
• License: mit
• Created: 2024-08-02T16:59:28.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T13:24:02.000Z (2 months ago)
• Last Synced: 2024-10-10T09:44:09.270Z (about 1 month ago)
• Topics: actions, cd, ci, ci-cd, github-action, license-management, unity, unity3d
• Language: TypeScript
• Homepage:
• Size: 264 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# activate-unity-license

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)

[![Managing GitHub Actions settings for a repository](RecommendedSecuritySettings.png)](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` and `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 |

| `configuration` | Unity License Client `services-config.json` encoded as base64 string | Required for `Floating` license activations |

### workflow

```yaml

steps:

  - uses: RageAgainstThePixel/activate-unity-license@v1

    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

```