rageagainstthepixel/unity-setup
A GitHub action for setting up the Unity Game Engine for CI/CD workflows.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version-file | Specify a path to search for the unity project version text file. Useful if there are multiple projects in a single repo. Pass `None` if creating a new project to skip file search. | no | "" |
| unity-version | Specify the Unity version(s) to install. example: `2019.4.13f1 (518737b1de84)`. ***This will override any version specified in the `version-file`!*** | no | "" |
| build-targets | Specify the build targets to install modules for. One or more of `StandaloneWindows64` `WSAPlayer` `StandaloneOSX` `iOS` `StandaloneLinux64` `Android` `Lumin` `WebGL` `VisionOS`. | no | "" |
| modules | Modules to install with the editor. This list can be different per editor version. | no | "" |
| architecture | Specify the architecture to install. Either `x86_64` or `arm64`. | no | "" |
| install-path | Specify the path where Unity will be installed to. | no | — |
| auto-update-hub | Automatically update Unity Hub to the latest version before installing Unity Editors. Can be `true` or `false`. | no | true |
| hub-version | Specify a specific version of Unity Hub to install. Example: `3.12.0`. When set, auto-update-hub is automatically disabled. | no | "" |
| cache-installation | Cache the Unity installation between workflow runs to speed up subsequent runs. Can be `true` or `false`. | no | false |
Outputs
| name | description |
|---|---|
| unity-hub-path | The file path to the Unity Hub installation. |
| unity-editors | A JSON array of all installed Unity Editors on the runner. |
| unity-editor-path | The path to the latest installed version of Unity. |
| unity-project-path | The file path to the Unity project. |