-
Notifications
You must be signed in to change notification settings - Fork 1.1k
More resilient release script #9128
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: master
Are you sure you want to change the base?
Conversation
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.
Summary of Changes
Hello @joehan, 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 significantly enhances the robustness of the release process by revamping how the next version number is determined. It moves away from querying the NPM registry post-publish, which was prone to timing issues, and instead captures the version directly from the local package.json
after the version increment. This change prevents the generation of artifacts with outdated version numbers, ensuring consistency and accuracy in releases.
Highlights
- Version Number Reliability: The release script has been updated to ensure a more reliable method of determining the next version number, addressing previous issues where incorrect versions were being used for artifact generation due to NPM registry delays.
- Direct Version Capture: The
publish.sh
script now directly captures the newly incremented version frompackage.json
after thenpm version
command and writes it to a shared file, eliminating reliance on potentially delayed NPM registry updates for the new version. - Simplified Cloud Build Step: The
cloudbuild.yaml
configuration has been simplified by removing the redundant step that previously attempted to read the new version number from NPM, as this process is now robustly handled within thepublish.sh
script itself.
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.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
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. ↩
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.
Code Review
This pull request improves the resilience of the release script by changing how the next version number is determined. Instead of relying on a potentially slow-to-update npm registry, the version is now sourced directly from package.json
after being bumped or fetched explicitly for artifact-only builds. This change effectively mitigates the race condition that was causing failures. The implementation looks solid. I have one minor suggestion to further improve the script's robustness.
echo "Making a $VERSION version..." | ||
npm version $VERSION | ||
NEW_VERSION=$(jq -r ".version" package.json) | ||
echo $NEW_VERSION > /workspace/version_number.txt |
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.
It's a good practice to quote variables in shell scripts to prevent potential issues with word splitting and filename expansion (globbing). While the version number is unlikely to contain spaces or special characters that would cause issues, quoting it makes the script more robust and is a widely-accepted best practice.
echo $NEW_VERSION > /workspace/version_number.txt | |
echo "$NEW_VERSION" > /workspace/version_number.txt |
Description
Update release script to have a more reliable method of getting the next version number.
Previously, this script just waited a while for NPM, and then read the latest version from there. Over the past month or so, this has repeatedly failed and generated artifacts for latestVersion - 1.