-
-
Notifications
You must be signed in to change notification settings - Fork 126
Document linux64RemoveExecutableExtension
#515
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.
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughA documentation update adds a new configuration option, linux64RemoveExecutableExtension, to docs/03-github/04-builder.mdx. It explains omitting the .x86_64 extension for StandaloneLinux64 builds, notes default is true (planned to flip to false later), marks it as not required, and places it before the Outputs section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/03-github/04-builder.mdx (1)
550-556
: Clarify scope, default-change timeline, and add a usage example.Good addition. A couple of improvements will reduce ambiguity and help users adopt the new flag safely:
- Make the platform scope explicit: “Only applicable when targetPlatform is StandaloneLinux64.”
- Clarify the timeline of the default flip (e.g., “in the next major version”) or reference the unity-builder PR number so readers know where to track it.
- Add a short YAML example showing how to set the flag (and demonstrate disabling it).
- Optional: Add a caution that this may affect downstream scripts that expect a .x86_64 suffix.
Consider applying the following patch to enrich this block:
#### linux64RemoveExecutableExtension -Omits the `.x86_64` file extension when building for StandaloneLinux64. This matches behavior with -older versions of the action. The default will be flipped to `false` in a future version. +Omits the `.x86_64` file extension when building for `StandaloneLinux64`. This matches behavior with +older versions of this action. Only applicable when `targetPlatform` is `StandaloneLinux64`. + +Note: The default is planned to change to `false` in a future major version of the action. See +game-ci/unity-builder PR #726 for details. _**required:** `false`_ _**default:** `true`_ + +Example: + +```yaml +- uses: game-ci/unity-builder@v4 + with: + targetPlatform: StandaloneLinux64 + linux64RemoveExecutableExtension: false +``` + +Tip: If your packaging or deployment scripts assume a `.x86_64` suffix, set this to `false` or update those scripts accordingly.If you prefer, we can instead link the PR explicitly: game-ci/unity-builder#726. Please confirm the intended version for the default flip so we can document it precisely (e.g., “in v5”).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/03-github/04-builder.mdx
(1 hunks)
🔇 Additional comments (1)
docs/03-github/04-builder.mdx (1)
550-556
: LGTM: Option documented clearly and consistent with surrounding sections.
- Name, scope, and required/default metadata match the style of other options.
- Placement under Configuration options is appropriate.
Changes
linux64RemoveExecutableExtension
, added in Add parameterlinux64RemoveExecutableExtension
unity-builder#726Checklist
code of conduct
Summary by CodeRabbit