Skip to content

fix(binary): improve bundle installation documentation and release versioning#5554

Merged
kvenkatachala333 merged 2 commits into
GoogleCloudPlatform:developfrom
kvenkatachala333:binary_upd
Apr 27, 2026
Merged

fix(binary): improve bundle installation documentation and release versioning#5554
kvenkatachala333 merged 2 commits into
GoogleCloudPlatform:developfrom
kvenkatachala333:binary_upd

Conversation

@kvenkatachala333

@kvenkatachala333 kvenkatachala333 commented Apr 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

This PR introduces documentation updates and addresses feedback raised in b/506109771 to improve the pre-built bundle installation.

  • Updated README.md to guide users to extract pre-compiled bundles into cluster-toolkit/ (rather than gcluster-bundle/)
  • Removed redundant chmod +x gcluster steps from README.md as release binaries arrive pre-packaged with execution permissions.
  • Implemented an explicit gitIsOfficial build flag in gcluster.go and cmd/root.go. Official release binaries built in CI/CD will report themselves as (official binary distribution), while local source builds will correctly report as - not built from official release.
  • Expanded the Makefile to accept and pass through the GIT_IS_OFFICIAL environment flag during Go compilation.

NOTE

Post-merge action required: Upon merging this PR, the Louhi Google Cloud Build (GCB) pipeline configuration will need to be updated to pass GIT_IS_OFFICIAL=true during the gcluster compilation steps.

@gemini-code-assist

gemini-code-assist Bot commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the installation documentation and CLI version output for the Cluster Toolkit. The changes ensure consistency with canonical developer guides and improve the clarity of version information displayed by the binary.

Highlights

  • README Updates: Updated installation instructions to extract bundles into the cluster-toolkit/ directory and removed redundant chmod commands.
  • Version Display: Modified cmd/root.go to update the version string for official binary distributions.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Apr 24, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README installation instructions to use the 'cluster-toolkit' directory and removes redundant chmod commands. It also modifies the versioning logic in 'cmd/root.go' to label builds as an official binary distribution when tag information is missing but commit info is present. Feedback suggests that this change in version reporting may be misleading for developers building from source on local branches, as it could incorrectly identify non-official builds as official distributions.

Comment thread cmd/root.go Outdated
@kvenkatachala333 kvenkatachala333 changed the title fix(readme): refine bundle extraction steps and version display fix(binary): improve bundle installation documentation and release versioning Apr 24, 2026
@kvenkatachala333

kvenkatachala333 commented Apr 24, 2026

Copy link
Copy Markdown
Member Author

/gemini review

@kvenkatachala333 kvenkatachala333 added the release-chore To not include into release notes label Apr 24, 2026
gemini-code-assist[bot]
gemini-code-assist Bot reviewed Apr 24, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a GitIsOfficial flag to the build process, allowing the tool to identify itself as an official binary distribution when no specific version tag is present. Additionally, the documentation is updated to reflect a new default extraction directory for pre-built bundles and removes unnecessary permission changes. I have no feedback to provide.

@kvenkatachala333 kvenkatachala333 marked this pull request as ready for review April 27, 2026 11:03
@kvenkatachala333 kvenkatachala333 requested a review from a team as a code owner April 27, 2026 11:03
@kvenkatachala333 kvenkatachala333 merged commit 0be95cb into GoogleCloudPlatform:develop Apr 27, 2026
27 of 87 checks passed
@kvenkatachala333 kvenkatachala333 deleted the binary_upd branch April 27, 2026 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cboneti cboneti cboneti approved these changes

@AdarshK15 AdarshK15 AdarshK15 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

release-chore To not include into release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kvenkatachala333 @cboneti @AdarshK15