mirror of
https://github.com/game-ci/unity-activate
synced 2026-01-29 06:10:34 +08:00
Move docs to unity-ci.com
This commit is contained in:
135
README.md
135
README.md
@@ -1,119 +1,46 @@
|
||||
# Unity - Activate
|
||||
<div align="center">
|
||||
<a href="https://github.com/marketplace/actions/unity-activate">
|
||||
<img width="800" src="media/UnityActivate-Logo.png" alt="Unity Activate">
|
||||
</a>
|
||||
<br />
|
||||
<br />
|
||||
|
||||
GitHub Action to [activate](https://github.com/marketplace/actions/unity-activate) Unity.
|
||||
|
||||
Part of the <a href="https://unity-ci.com"><img height="30" src="media/UnityCI-ReferenceLogo.png" alt="Unity CI"></a> open source project.
|
||||
<br />
|
||||
<br />
|
||||
|
||||
[](https://github.com/webbertakken/unity-activate/actions?query=branch%3Amaster+event%3Apush+workflow%3A"Actions%20%F0%9F%98%8E")
|
||||
<br />
|
||||
<br />
|
||||
|
||||
---
|
||||
</div>
|
||||
|
||||
GitHub Action to [activate Unity](https://github.com/marketplace/actions/unity-activate).
|
||||
## How to use
|
||||
|
||||
Part of the [Unity Actions](https://github.com/webbertakken/unity-actions) collection.
|
||||
Find the
|
||||
[docs](https://unity-ci.com/docs/github)
|
||||
on the Unity CI
|
||||
[website](https://unity-ci.com/).
|
||||
|
||||
---
|
||||
## Related actions
|
||||
|
||||
Use this action to activate Unity using credentials or a license file. Both
|
||||
**personal** and **professional** licenses are supported.
|
||||
Visit the
|
||||
<a href="https://github.com/webbertakken/unity-actions"><img height="30" src="media/UnityActions-ReferenceLogo.png" alt="Unity Actions"></a>
|
||||
status repository for related Actions.
|
||||
|
||||
Note that the latest versions of
|
||||
[Test](https://github.com/webbertakken/unity-actions#test) and
|
||||
[Build](https://github.com/webbertakken/unity-actions#build)
|
||||
contain standalone activation and no longer require this action.
|
||||
## Community
|
||||
|
||||
### Documentation
|
||||
Feel free to join us on
|
||||
<a href="http://unity-ci.com/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
|
||||
and engage with the community.
|
||||
|
||||
See the
|
||||
[Unity Actions](https://github.com/webbertakken/unity-actions)
|
||||
collection repository for workflow documentation and reference implementation.
|
||||
## Contributing
|
||||
|
||||
## Usage
|
||||
To help out sharpen the documentation, please find the docs [repository](https://github.com/Unity-CI/Website).
|
||||
|
||||
Create or edit the file called `.github/workflows/main.yml` and add a job to it.
|
||||
|
||||
```yaml
|
||||
name: Activate Unity
|
||||
on: [push]
|
||||
jobs:
|
||||
requestActivation:
|
||||
name: Request activation ✔
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
```
|
||||
|
||||
Continue to either the personal license or professional license section below.
|
||||
|
||||
#### Personal license
|
||||
|
||||
1. Follow the **activation** section from [request action](https://github.com/marketplace/actions/unity-request-activation-file) to set `UNITY_LICENSE` variable.
|
||||
2. Use the action as follows:
|
||||
|
||||
```yaml
|
||||
- name: Activate Unity
|
||||
uses: webbertakken/unity-activate@v1.2
|
||||
env:
|
||||
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
|
||||
```
|
||||
|
||||
#### Professional license
|
||||
|
||||
1. Goto `Repository` > `Settings` > `Secrets`
|
||||
2. Set the following secrets:
|
||||
- `UNITY_EMAIL`: <your_unity_login_email_address>
|
||||
- `UNITY_PASSWORD`: <your_unity_login_password>
|
||||
- `UNITY_SERIAL`: <your_unity_serial>
|
||||
3. Use the action as follows:
|
||||
|
||||
```yaml
|
||||
- name: Activate Unity
|
||||
uses: webbertakken/unity-activate@v1.2
|
||||
env:
|
||||
UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
|
||||
UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
|
||||
UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
|
||||
```
|
||||
|
||||
#### Specifying version
|
||||
|
||||
Major version differences may require different activation files.
|
||||
|
||||
To activate this job's environment for a specific version of unity
|
||||
|
||||
```yaml
|
||||
- name: Activate Unity
|
||||
uses: webbertakken/unity-activate@v1.2
|
||||
env:
|
||||
UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
|
||||
with:
|
||||
unityVersion: 2019.2.11f1
|
||||
```
|
||||
|
||||
#### Returning licenses
|
||||
|
||||
When using Pro licenses, free spots are being used up by activating licenses.
|
||||
|
||||
In order to keep continuity you need to return the license at the end of your workflow.
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
- name: Return license
|
||||
uses: webbertakken/unity-return-license@v1
|
||||
if: always()
|
||||
```
|
||||
|
||||
For specific information about returning the license, visit
|
||||
the [return license](https://github.com/marketplace/actions/unity-return-license)
|
||||
docs.
|
||||
|
||||
#### Save your workflow
|
||||
|
||||
Commit and push your workflow definition.
|
||||
|
||||
## More actions
|
||||
|
||||
Visit
|
||||
[Unity Actions](https://github.com/webbertakken/unity-actions)
|
||||
to find related actions for Unity.
|
||||
|
||||
Feel free to contribute.
|
||||
To contribute to Unity Builder, kindly read the [contribution guide](./CONTRIBUTING.md).
|
||||
|
||||
## Licence
|
||||
|
||||
|
||||
Reference in New Issue
Block a user