Update docs around floating licensing configurations #472
Conversation
|
|
|
@coderabbitai do a full review |
|
Warning Rate limit exceeded@GabLeRoux has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 24 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe documentation for Unity-related GitHub Actions has been updated to include new configuration options for utilizing a Unity licensing server. Key additions include the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@GabLeRoux: I will perform a full review of the PR as per your request. ✅ Actions performedFull review triggered. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (5)
docs/03-github/02-activation.mdx (2)
94-100: Enhance the YAML example with more specific guidance.While the example structure is correct, it could be more helpful with:
- Real-world example values instead of placeholders
- A note about the expected format of product IDs
Consider updating the example like this:
- uses: game-ci/unity-builder@v4 with: targetPlatform: WebGL - unityLicensingServer: [url to your license server] - unityLicensingProductIds: [comma separated product ids] + unityLicensingServer: http://license.company.com:8080 + # Specify one or more product IDs, separated by commas + unityLicensingProductIds: Unity_Editor_2020,Unity_Editor_2021
Line range hint
82-86: Add context about when to use a license server.Consider adding a brief introduction explaining when organizations might want to use a license server (e.g., for managing licenses across multiple developers or CI/CD pipelines in an enterprise setting). This would help readers better understand if this option is relevant for their use case.
Example addition before the current content:
## License Server +Enterprise users often need to manage Unity licenses across multiple developers or CI/CD pipelines. +A Unity license server provides centralized license management for these scenarios. + If you host your own Unity license server you can provide its url using `unityLicensingServer`. A floating license will be acquired before the build, and returned after.docs/03-github/03-test-runner.mdx (2)
77-90: Improve YAML example indentation for consistency.The content accurately documents the
unityLicensingProductIdsparameter. However, the YAML example could be better indented to match the style used in other examples throughout the document.Consider adjusting the indentation:
- uses: game-ci/unity-test-runner@v4 - with: - projectPath: path/to/your/project - unityLicensingServer: [url to your license server] - unityLicensingProductIds: [comma separated product ids] + uses: game-ci/unity-test-runner@v4 + with: + projectPath: path/to/your/project + unityLicensingServer: [url to your license server] + unityLicensingProductIds: [comma separated product ids]
576-588: Enhance parameter descriptions with example values.The parameter documentation is well-structured and accurate. Consider enhancing it with example values to make it more user-friendly.
Add examples like:
Sets the url to a unity license server for acquiring floating licenses. + +Example: `http://license.example.com:8080` _**required:** `false`_ _**default:** `""`_ #### unityLicensingProductIds Comma separated list of license product identifiers to request licenses for from the unity license server. + +Example: `Unity_Pro,Unity_Android` _**required:** `false`_ _**default:** `""`_docs/03-github/04-builder.mdx (1)
90-98: Consider using more descriptive placeholder values.While the example is well-structured, consider using more descriptive placeholder values to help users understand the expected format:
- unityLicensingServer: [url to your license server] - unityLicensingProductIds: [comma separated product ids] + unityLicensingServer: http://license-server.company.com:8080 + unityLicensingProductIds: Unity_Pro_2020,Unity_Pro_2021
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- docs/03-github/02-activation.mdx (1 hunks)
- docs/03-github/03-test-runner.mdx (2 hunks)
- docs/03-github/04-builder.mdx (2 hunks)
🔇 Additional comments (3)
docs/03-github/02-activation.mdx (1)
88-90: Documentation looks good!The explanation about multiple product licenses is clear and the reference to Unity's official documentation provides valuable additional context.
docs/03-github/03-test-runner.mdx (1)
77-90: Documentation changes look good!The additions effectively document the floating licensing configurations with clear explanations, examples, and references to official Unity documentation. The changes align well with the PR objectives.
Also applies to: 576-588
docs/03-github/04-builder.mdx (1)
86-88: LGTM! Clear introduction to product identifiers.The text effectively introduces the concept and provides a helpful link to Unity's official documentation for more details.
| #### unityLicensingProductIds | ||
|
|
||
| Comma separated list of license product identifiers to request licenses for from the unity license | ||
| server. | ||
|
|
||
| _**required:** `false`_ _**default:** `""`_ |
There was a problem hiding this comment.
🛠️ 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.
| #### 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:** `""`_ |
Changes
unityLicensingProductIdsparameters introduced in Support multiple licensing products unity-builder#661 and Support Multiple License Products when using Unity Licensing Server unity-test-runner#282unityLicensingServerChecklist
code of conduct
Summary by CodeRabbit
New Features
unityLicensingServerandunityLicensingProductIds.Documentation