Fix indentation closes #481

[GabLeRoux]

Fix indentation closes #481

[coderabbitai]

Walkthrough

The changes made to the 04-builder.mdx document enhance the clarity and detail of the setup and usage instructions for the Unity Builder GitHub Action. Key updates include improved instructions for handling SSH keys, expanded UPM authentication steps, a complete multi-platform workflow example, and clarified caching guidelines. Formatting improvements were also implemented for better readability, alongside a reorganization of configuration options to clearly indicate required and default values.

Changes

File	Change Summary
docs/03-github/04-builder.mdx	Enhanced instructions for SSH keys, expanded UPM authentication, added multi-platform workflow example, clarified caching, and improved formatting.

Assessment against linked issues

Objective	Addressed	Explanation
Correct indentation for "ssh-private-key" property (481)	❌	The documentation does not address the indentation issue.

🐰 In the garden of code, we hop with glee,
With clearer paths and steps, as bright as can be!
SSH keys and workflows, all neatly aligned,
For building our dreams, with ease we shall find.
So let’s leap into action, with joy in our hearts,
In this world of GitHub, where creativity starts! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7ffdb89 and ef59ada.

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

626-629: LGTM! Indentation fix looks correct.

The indentation of the SSH keys under the ssh-private-key property has been properly aligned, fixing the issue reported in #481. This ensures the YAML example is correctly formatted and will work as expected when users copy it.

---

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 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.

[github-actions]

[github-actions]

Visit the preview URL for this PR (updated for commit ef59ada):

https://game-ci-5559f--pr483-fix-builder-docs-exa-2p83l55l.web.app

_{(expires Fri, 22 Nov 2024 14:38:01 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b}

[GabLeRoux]

Coderabbitai says it does not address the issue, but it does. (it pretty much only does this and nothing else it wrote 😂)