Skip to content

Commit cd9523d

Browse files
empty-setjsm174
authored andcommitted
doc: adding Unity License Setup
1 parent 8cb71d9 commit cd9523d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ and let our peers review the code before it gets merged.
1313
- We try to prefix our commit messages with a word that quickly tells the reader where the change happened. Examples are `editor`, `doc`, `<component-name>`, etc.
1414
- Changes that touch the core project should be unit-tested.
1515

16+
### Unity License Setup For Automated Testing
17+
18+
It's preferred to make the automated tests run when creating your PR. Since Unity needs a license key (which can be obtained with a free account), you'll need to configure your fork to use the correct secrets. You will need to use a Personal license and request a key on behalf of GitHub:
19+
20+
1. Run the `License` workflow by clicking the `Run workflow` button in the `Actions` tab. When the workflow completes, download and unzip the `Unity_v2021.3.0f1.alf` artifact.
21+
2. Visit [license.unity3d.com](https://license.unity3d.com), sign in, and upload the `Unity_v2021.3.0f1.alf` file.
22+
3. You should now receive your license file (`Unity_v2021.x.ulf`) as a download.
23+
4. Open `Github` > `<Your repository>` > `Settings` > `Secrets`
24+
- Create the following secret:
25+
- `UNITY_LICENSE` - (Copy the contents of the `Unity_v2021.x.ulf` license file here)
26+
5. Delete the `License` workflow run by selecting `Delete workflow run` in the `...` menu.
27+
1628
## Code Style
1729

1830
We aren't too picky about code style. Just start reading our code and you'll get the hang of it. There

0 commit comments

Comments
 (0)