Skip to content

Commit 6cdeb78

Browse files
committed
Prepare readme for v0.1 pre-release
1 parent 139aaec commit 6cdeb78

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,67 @@ action from the
1010
[Unity Actions](https://github.com/webbertakken/unity-actions)
1111
collection before running this action. This action also requires the [Activation](https://github.com/marketplace/actions/unity-activate) step.
1212

13+
## Documentation
14+
15+
See the
16+
[Unity Actions](https://github.com/webbertakken/unity-actions)
17+
collection repository for workflow documentation and reference implementation.
18+
19+
## Usage
20+
21+
Create or edit the file called `.github/workflows/main.yml` and add a job to it.
22+
23+
```yaml
24+
name: Build project
25+
on: [push]
26+
jobs:
27+
buildForWebGL:
28+
name: Build for WebGL 🕸
29+
runs-on: ubuntu-latest
30+
steps:
31+
```
32+
33+
Configure the builder as follows:
34+
35+
```yaml
36+
# Configure builder
37+
- name: Build project
38+
id: buildStep
39+
uses: webbertakken/[email protected] # WIP (only webgl for now)
40+
env:
41+
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
42+
43+
# Optional: Path to your project, leave blank for "./"
44+
UNITY_PROJECT_PATH: path/to/your/project
45+
46+
# Name for your build
47+
BUILD_NAME: TestBuild
48+
49+
# Optional: Builds path, leave blank for "build"
50+
BUILDS_PATH: build
51+
52+
# Target platform for your build
53+
BUILD_TARGET: WebGL
54+
55+
# Optional: <StaticBuildClass.StaticMethod>, defaults to Builder.BuildProject
56+
BUILD_COMMAND: ""
57+
```
58+
59+
You use the id to **upload your built files** like so:
60+
61+
```yaml
62+
# Upload distributables
63+
- name: Upload Build
64+
uses: actions/upload-artifact@v1
65+
with:
66+
name: Build
67+
path: ${{ steps.buildStep.outputs.allBuildsPath }}
68+
```
69+
70+
Commit and push your workflow definition.
71+
72+
## More actions
73+
74+
Visit
75+
[Unity Actions](https://github.com/webbertakken/unity-actions)
76+
to find related actions for Unity.

0 commit comments

Comments
 (0)