Skip to content

🔧 strip README dependency patches via hook#2368

Merged
ChanTsune merged 1 commit into
mainfrom
cargo-release/strip-patch-version-in-readme
Nov 22, 2025
Merged

🔧 strip README dependency patches via hook#2368
ChanTsune merged 1 commit into
mainfrom
cargo-release/strip-patch-version-in-readme

Conversation

@ChanTsune
Copy link
Copy Markdown
Owner

No description provided.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @ChanTsune, 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 automates the process of simplifying version references within README.md files as part of the release workflow. By integrating a pre-release-hook into the release.toml configuration, it ensures that any full version numbers (e.g., '1.2.3') found in READMEs are automatically truncated to their minor version (e.g., '1.2') before a release is finalized. This enhancement aims to streamline documentation maintenance by ensuring version compatibility references are consistently updated.

Highlights

  • Automated README Version Stripping: Introduces a new pre-release hook to automatically modify version numbers in README.md files during the release process.
  • Version Simplification Logic: The hook replaces full version strings (e.g., "1.2.3") with their minor counterparts (e.g., "1.2") within specific patterns found in README.md files.
  • New Script for Version Patching: Adds a new bash script, scripts/strip-readme-patch.sh, which orchestrates finding README.md files and performing the version string replacement using perl.
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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 introduces a pre-release hook to automate stripping patch versions from version numbers in README files. This is a useful addition to the release process. My review focuses on the new shell script and its invocation. I've identified a significant bug in the version parsing logic within the script, along with several opportunities for simplification and improving reproducibility. I've provided specific suggestions to address these points.

Comment thread scripts/strip-readme-patch.sh Outdated
Comment thread release.toml
Comment thread scripts/strip-readme-patch.sh
Comment thread scripts/strip-readme-patch.sh Outdated
@ChanTsune ChanTsune force-pushed the cargo-release/strip-patch-version-in-readme branch from 43fe4a0 to 8139e00 Compare November 22, 2025 05:24
@ChanTsune ChanTsune merged commit f62e6fb into main Nov 22, 2025
104 of 105 checks passed
@ChanTsune ChanTsune deleted the cargo-release/strip-patch-version-in-readme branch November 22, 2025 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant