Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs around floating licensing configurations #472

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+62 −0
Open

Update docs around floating licensing configurations #472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8c57a9
update docs around licensing configs
ejnarvala Aug 7, 2024
edef4fa
Merge branch 'main' into main
GabLeRoux Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/03-github/02-activation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,20 @@ Example of use:
unityLicensingServer: [url to your license server]
```

Additionally, if your licensing server has multiple product licenses configured, you can specify the
product identifier(s) that will be requested. More information about multiple products can be found
[here](https://docs.unity.com/licensing/en-us/manual/ServerSetup-test#Support_for_multiple_product_licenses).

Example of use:

```yaml
- uses: game-ci/unity-builder@v4
with:
targetPlatform: WebGL
unityLicensingServer: [url to your license server]
unityLicensingProductIds: [comma separated product ids]
```

## Optional steps

- Verify your license using [Activate](https://github.com/marketplace/actions/unity-activate).
Expand Down
27 changes: 27 additions & 0 deletions docs/03-github/03-test-runner.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,20 @@ Example of use:
unityLicensingServer: [url to your license server]
```

Additionally, if your licensing server has multiple product licenses configured, you can specify the
product identifier(s) that will be requested. More information about multiple products can be found
[here](https://docs.unity.com/licensing/en-us/manual/ServerSetup-test#Support_for_multiple_product_licenses).

Example of use:

```yaml
- uses: game-ci/unity-test-runner@v4
with:
projectPath: path/to/your/project
unityLicensingServer: [url to your license server]
unityLicensingProductIds: [comma separated product ids]
```

That is all you need to test your project.

## Testing Projects with a private scoped registry
Expand Down Expand Up @@ -559,6 +573,19 @@ artifacts.

_**required:** `false`_ _**default:** `""`_

#### unityLicensingServer

Sets the url to a unity license server for acquiring floating licenses.

_**required:** `false`_ _**default:** `""`_

#### unityLicensingProductIds

Comma separated list of license product identifiers to request licenses for from the unity license
server.

_**required:** `false`_ _**default:** `""`_

## Complete example

A complete workflow that tests all modes separately could look like this:
Expand Down
21 changes: 21 additions & 0 deletions docs/03-github/04-builder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,20 @@ Example of use:
unityLicensingServer: [url to your license server]
```

Additionally, if your licensing server has multiple product licenses configured, you can specify the
product identifier(s) that will be requested. More information about multiple products can be found
[here](https://docs.unity.com/licensing/en-us/manual/ServerSetup-test#Support_for_multiple_product_licenses).

Example of use:

```yaml
- uses: game-ci/unity-builder@v4
with:
targetPlatform: WebGL
unityLicensingServer: [url to your license server]
unityLicensingProductIds: [comma separated product ids]
```

That is all you need to build your project.

By default, the enabled scenes from the project's settings will be built.
Expand Down Expand Up @@ -437,6 +451,13 @@ Sets the url to a unity license server for acquiring floating licenses.

_**required:** `false`_ _**default:** `""`_

#### unityLicensingProductIds

Comma separated list of license product identifiers to request licenses for from the unity license
server.

_**required:** `false`_ _**default:** `""`_
Comment on lines +454 to +459
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance parameter documentation with more details.

Consider adding more details to help users understand the parameter better:

 #### unityLicensingProductIds
 
-Comma separated list of license product identifiers to request licenses for from the unity license
-server.
+Comma separated list of license product identifiers to request from the unity license server. Each
+identifier corresponds to a specific Unity product license (e.g., Unity_Pro, Unity_Plus).
+
+Example: `Unity_Pro_2020,Unity_Pro_2021`
 
 _**required:** `false`_ _**default:** `""`_
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
#### unityLicensingProductIds
Comma separated list of license product identifiers to request licenses for from the unity license
server.
_**required:** `false`_ _**default:** `""`_
#### unityLicensingProductIds
Comma separated list of license product identifiers to request from the unity license server. Each
identifier corresponds to a specific Unity product license (e.g., Unity_Pro, Unity_Plus).
Example: `Unity_Pro_2020,Unity_Pro_2021`
_**required:** `false`_ _**default:** `""`_


#### cacheUnityInstallationOnMac

Enables caching the Unity Hub and Editor installation for MacOS runners. This can significantly
Expand Down