2020-12-06 16:57:57 +00:00
|
|
|
# Unity - Builder
|
|
|
|
|
|
|
|
|
|
(Not affiliated with Unity Technologies)
|
2019-12-03 22:16:18 +00:00
|
|
|
|
2025-09-06 02:05:00 +00:00
|
|
|
GitHub Action to [build Unity projects](https://github.com/marketplace/actions/unity-builder) for different platforms.
|
2019-12-03 22:16:18 +00:00
|
|
|
|
2025-09-06 02:05:00 +00:00
|
|
|
Part of the <a href="https://game.ci">GameCI</a> open source project. <br /> <br />
|
2019-12-07 23:59:14 +00:00
|
|
|
|
2023-03-04 21:39:31 +00:00
|
|
|
[](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-ubuntu.yml)
|
|
|
|
|
[](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-windows.yml)
|
|
|
|
|
[](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-mac.yml)
|
2021-03-14 00:19:30 +00:00
|
|
|
[](https://codecov.io/gh/game-ci/unity-builder)
|
2025-09-06 02:05:00 +00:00
|
|
|
<br /> <br />
|
2020-07-08 20:44:54 +00:00
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
## How to use
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2025-09-06 02:05:00 +00:00
|
|
|
Find the [docs](https://game.ci/docs/github/builder) on the GameCI [documentation website](https://game.ci/docs).
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
## Related actions
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2025-09-06 02:05:00 +00:00
|
|
|
Visit the GameCI <a href="https://github.com/game-ci/unity-actions">Unity Actions</a> status repository for related
|
|
|
|
|
Actions.
|
|
|
|
|
|
|
|
|
|
## AWS provider with local emulator
|
|
|
|
|
|
|
|
|
|
The AWS provider can target a local AWS emulator such as [LocalStack](https://github.com/localstack/localstack).
|
|
|
|
|
Configure the endpoint URLs through environment variables before running tests or the action:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
AWS_ENDPOINT=http://localhost:4566
|
|
|
|
|
AWS_ACCESS_KEY_ID=test
|
|
|
|
|
AWS_SECRET_ACCESS_KEY=test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
When these variables are set, Unity Builder will direct its CloudFormation, ECS, Kinesis, CloudWatch Logs and S3 clients
|
|
|
|
|
to the emulator instead of the real AWS services. See `.github/workflows/cloud-runner-integrity-localstack.yml` for an
|
|
|
|
|
example configuration.
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2025-09-08 21:06:17 +00:00
|
|
|
## Rclone storage provider (experimental)
|
|
|
|
|
|
|
|
|
|
Unity Builder can use rclone as an alternative storage provider for cache and build artifacts in Cloud Runner.
|
|
|
|
|
|
|
|
|
|
- Inputs:
|
|
|
|
|
- `storageProvider`: set to `rclone` to enable rclone-backed storage (default is `s3`).
|
|
|
|
|
- `rcloneRemote`: rclone remote to use, e.g. `s3:my-bucket`, `gcs:my-bucket`, `local:./path`.
|
|
|
|
|
|
|
|
|
|
When `storageProvider=rclone`:
|
|
|
|
|
|
|
|
|
|
- Retained workspace locking uses rclone operations instead of S3 (touch/delete/ls).
|
|
|
|
|
- Built-in container hooks are available:
|
|
|
|
|
- `rclone-pull-cache`, `rclone-upload-cache`
|
|
|
|
|
- `rclone-pull-build`, `rclone-upload-build`
|
|
|
|
|
|
|
|
|
|
You must ensure the `rclone` CLI is available in the container runtime. The built-in hooks use the `rclone/rclone` image.
|
|
|
|
|
|
|
|
|
|
Example (local testing): set `RCLONE_REMOTE=local:./temp/rclone-remote` and include the rclone hooks via `containerHookFiles`.
|
|
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
## Community
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
Feel free to join us on
|
2025-09-06 02:05:00 +00:00
|
|
|
<a href="http://game.ci/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a> and engage with the
|
|
|
|
|
community.
|
2020-01-27 18:52:17 +00:00
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
## Contributing
|
2019-12-01 01:03:52 +00:00
|
|
|
|
2020-12-06 16:57:57 +00:00
|
|
|
To help improve the documentation, please find the docs [repository](https://github.com/game-ci/documentation).
|
2019-12-03 22:27:05 +00:00
|
|
|
|
2020-07-11 12:38:02 +00:00
|
|
|
To contribute to Unity Builder, kindly read the [contribution guide](./CONTRIBUTING.md).
|
2019-12-03 22:27:05 +00:00
|
|
|
|
2021-07-12 17:28:11 +00:00
|
|
|
## Support us
|
|
|
|
|
|
|
|
|
|
GameCI is free for everyone forever.
|
|
|
|
|
|
|
|
|
|
You can support us at [OpenCollective](https://opencollective.com/game-ci).
|
|
|
|
|
|
2019-12-22 21:06:34 +00:00
|
|
|
## Licence
|
2019-12-03 22:27:05 +00:00
|
|
|
|
2021-07-12 17:28:11 +00:00
|
|
|
This repository is [MIT](./LICENSE) licensed.
|
|
|
|
|
|
|
|
|
|
This includes all contributions from the community.
|
