fix(release): Improve Patch Release Workflow Comments: Clearer Approval Guidance

[jerop]

This implements improvements outlined in #21893 to provide clearer, actionable feedback during the patch release process.

Changes include:

• Updating status messages to explicitly state when a workflow is "Waiting for Approval" instead of ambiguously saying it "Started" or "Running".
• Providing exact workflow run links in comments to prevent maintainers from having to hunt for the "most recent run" and risking approving the wrong release.
• Making Step 3 deployment approval status messages environment-aware (only prompting for manual deployment approval on prod).
• Adding [Step X/4] prefixes to all patch release workflow comment titles to clearly indicate where the release is in its lifecycle.

Fixes #21893

[github-actions]

Size Change: -4 B (0%)

Total Size: 26.2 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	25.7 MB	-4 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js	221 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js	227 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js	11.5 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js	132 B	0 B
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 clarity and actionability of comments generated during the patch release workflow. The changes aim to streamline the release process by providing more precise status updates, direct links to relevant workflow runs, and explicit guidance for manual approvals, thereby improving the maintainer experience and reducing potential errors.

Highlights

• Clearer Approval Guidance: Updated status messages to explicitly state when a workflow is 'Waiting for Approval' instead of ambiguously saying it 'Started' or 'Running', particularly for production deployments.
• Direct Workflow Links: Provided exact workflow run links in comments, eliminating the need for maintainers to search for the correct run and reducing the risk of approving the wrong release.
• Environment-Aware Messaging: Implemented environment-aware messaging for Step 3 deployment approval status, prompting for manual deployment approval only on the production environment.
• Step Numbering: Added '[Step X/4]' prefixes to all patch release workflow comment titles to clearly indicate the current stage of the release lifecycle.

Changelog

• scripts/releasing/patch-comment.js
  • Added '[Step 4/4]' prefix to various patch release outcome comments (complete, cancelled, failed).
  • Updated workflow links to be more specific, differentiating between 'This release workflow run' and 'Workflow History'.
  • Refined the wording for race condition failure status from 'started' to 'triggered'.
• scripts/releasing/patch-create-comment.js
  • Introduced '[Step 2/4]' prefix to all patch creation related comments (permission issue, PR exists, branch exists, PR created, creation failed).
  • Added direct links to 'This patch creation workflow run' for better traceability.
• scripts/releasing/patch-trigger.js
  • Declared a new runId variable to capture the current GitHub Actions run ID.
  • Modified the 'Patch Release Started!' comment to include '[Step 3/4]' and dynamically display 'Waiting for Approval' for production environments.
  • Updated the status message to explicitly guide users to approve deployment for production releases and added specific links to 'release workflow history' and 'This trigger workflow run'.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/release-patch-0-from-comment.yml

Activity

• No human activity has been recorded on this pull request yet.

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

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]

Code Review

The changes in this pull request significantly improve the clarity and guidance within the patch release workflow. By adding step prefixes, making status messages environment-aware, and providing direct links to workflow runs and history, maintainers will have a much clearer understanding of the release process and any required actions. These updates directly address the objectives outlined in the pull request description, enhancing the user experience and reducing potential confusion during critical release operations. All modifications are well-implemented and contribute positively to the project's maintainability and operational efficiency.

[mattKorwel]

LGTM!