Update docs around floating licensing configurations

[ejnarvala]

Changes

• add examples in activation, unity builder v4, and unity test runner v3 docs
• adds docs for unityLicensingProductIds parameters introduced in https://github.com/game-ci/unity-builder/pull/661 and https://github.com/game-ci/unity-test-runner/pull/282
• add missing test runner v3 parameter for unityLicensingServer

Checklist

• [x] Read the contribution guide and accept the code of conduct
• [x] Readme (updated or not needed)
• [x] Tests (added, updated or not needed)

Summary by CodeRabbit

• New Features

  • Added documentation for configuring Unity licensing server options, including unityLicensingServer and unityLicensingProductIds.
  • Provided examples for using the new parameters in YAML configurations for the Unity Test Runner and Builder actions.

• Documentation

  • Enhanced guidance for managing multiple product licenses with Unity licensing servers.
  • Minor formatting adjustments for improved readability and consistency.

[github-actions[bot]]

[GabLeRoux]

@coderabbitai do a full review

[coderabbitai[bot]]

Walkthrough

The documentation for Unity-related GitHub Actions has been updated to include new configuration options for utilizing a Unity licensing server. Key additions include the unityLicensingServer and unityLicensingProductIds parameters, which allow users to specify the license server URL and manage multiple product identifiers, respectively. Examples and clarifications have been integrated into the existing documentation for the Unity Builder and Unity Test Runner, enhancing the guidance for users managing complex licensing setups while maintaining the original content's structure.

Changes

File Path	Change Summary
docs/03-github/02-activation.mdx	Added new section for unityLicensingProductIds parameter; clarified floating license acquisition.
docs/03-github/03-test-runner.mdx	Introduced unityLicensingServer and unityLicensingProductIds options; included usage examples.
docs/03-github/04-builder.mdx	Added section on unityLicensingProductIds and clarified its optional nature; referenced unityLicensingServer.

Possibly related PRs

• #491: The changes in this PR also involve updates to the Unity activation documentation, specifically enhancing clarity around activation methods, which relates to the main PR's focus on Unity licensing server configurations.
• #492: This PR includes updates to the Unity activation methods in GitLab CI/CD, specifically mentioning the unityLicensingProductIds parameter, which directly connects to the changes made in the main PR regarding the same parameter in the Unity builder action documentation.

Poem

In the garden of code, we hop and play,
New licenses bloom, brightening the day.
With servers and products, we dance with glee,
Unity's magic, as sweet as can be!
🐇✨ Let's build and test, let our dreams take flight,
With every new feature, our future is bright!

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between edef4fa46e59e30d266074d865fed52bdc46fe38 and 96500e8ffd4a21097332004aa978f5e85c599502.

📒 Files selected for processing (2)

• docs/03-github/02-activation.mdx (1 hunks)
• docs/03-github/04-builder.mdx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/03-github/02-activation.mdx

🔇 Additional comments (2)

docs/03-github/04-builder.mdx (2)

86-99: LGTM! Clear and helpful documentation.

The added section about multiple product licenses is well-structured, includes relevant context, and provides a helpful example configuration.

---

454-459: Enhance parameter documentation with more details.

The parameter documentation could be more helpful with additional details and examples.

Apply this diff to improve the documentation:

 #### 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:** `""`_

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai[bot]]

@GabLeRoux: I will perform a full review of the PR as per your request.

:white_check_mark: Actions performed

Full review triggered.