Skip to content

Commit d6cc453

Browse files
authored
Update README.md
1 parent bd1be2e commit d6cc453

File tree

1 file changed

+17
-42
lines changed

1 file changed

+17
-42
lines changed

README.md

Lines changed: 17 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,39 @@
22

33
(Not affiliated with Unity Technologies)
44

5-
GitHub Action to [build Unity projects](https://github.com/marketplace/actions/unity-builder) for different platforms.
5+
GitHub Action to
6+
[build Unity projects](https://github.com/marketplace/actions/unity-builder)
7+
for different platforms.
68

7-
Part of the <a href="https://game.ci">GameCI</a> open source project. <br /> <br />
9+
Part of the <a href="https://game.ci">GameCI</a> open source project.
10+
<br />
11+
<br />
812

913
[![Builds - Ubuntu](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-ubuntu.yml/badge.svg)](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-ubuntu.yml)
1014
[![Builds - Windows](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-windows.yml/badge.svg)](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-windows.yml)
1115
[![Builds - MacOS](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-mac.yml/badge.svg)](https://github.com/game-ci/unity-builder/actions/workflows/build-tests-mac.yml)
1216
[![codecov - test coverage](https://codecov.io/gh/game-ci/unity-builder/branch/master/graph/badge.svg)](https://codecov.io/gh/game-ci/unity-builder)
13-
<br /> <br />
17+
<br />
18+
<br />
1419

1520
## How to use
1621

17-
Find the [docs](https://game.ci/docs/github/builder) on the GameCI [documentation website](https://game.ci/docs).
22+
Find the
23+
[docs](https://game.ci/docs/github/builder)
24+
on the GameCI
25+
[documentation website](https://game.ci/docs).
1826

1927
## Related actions
2028

21-
Visit the GameCI <a href="https://github.com/game-ci/unity-actions">Unity Actions</a> status repository for related
22-
Actions.
23-
24-
## AWS provider with local emulator
25-
26-
The AWS provider can target a local AWS emulator such as [LocalStack](https://github.com/localstack/localstack).
27-
Configure the endpoint URLs through environment variables before running tests or the action:
28-
29-
```
30-
AWS_ENDPOINT=http://localhost:4566
31-
AWS_ACCESS_KEY_ID=test
32-
AWS_SECRET_ACCESS_KEY=test
33-
```
34-
35-
When these variables are set, Unity Builder will direct its CloudFormation, ECS, Kinesis, CloudWatch Logs and S3 clients
36-
to the emulator instead of the real AWS services. See `.github/workflows/cloud-runner-integrity-localstack.yml` for an
37-
example configuration.
38-
39-
## Rclone storage provider (experimental)
40-
41-
Unity Builder can use rclone as an alternative storage provider for cache and build artifacts in Cloud Runner.
42-
43-
- Inputs:
44-
- `storageProvider`: set to `rclone` to enable rclone-backed storage (default is `s3`).
45-
- `rcloneRemote`: rclone remote to use, e.g. `s3:my-bucket`, `gcs:my-bucket`, `local:./path`.
46-
47-
When `storageProvider=rclone`:
48-
49-
- Retained workspace locking uses rclone operations instead of S3 (touch/delete/ls).
50-
- Built-in container hooks are available:
51-
- `rclone-pull-cache`, `rclone-upload-cache`
52-
- `rclone-pull-build`, `rclone-upload-build`
53-
54-
You must ensure the `rclone` CLI is available in the container runtime. The built-in hooks use the `rclone/rclone` image.
55-
56-
Example (local testing): set `RCLONE_REMOTE=local:./temp/rclone-remote` and include the rclone hooks via `containerHookFiles`.
29+
Visit the
30+
GameCI <a href="https://github.com/game-ci/unity-actions">Unity Actions</a>
31+
status repository for related Actions.
5732

5833
## Community
5934

6035
Feel free to join us on
61-
<a href="http://game.ci/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a> and engage with the
62-
community.
36+
<a href="http://game.ci/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
37+
and engage with the community.
6338

6439
## Contributing
6540

0 commit comments

Comments
 (0)