Auto-sync README install examples with each release's version - #29
Merged
Conversation
release.yml: add a step that rewrites this branch's own pip/%pip install ...@vX.Y.Z[-staging] example lines in README.md to the version just resolved, then commits (with [skip ci]) and pushes if anything changed. main's run only touches the plain @vX.Y.Z lines (matched by the trailing quote), staging's only the -staging-suffixed ones, so a run on one branch can never clobber the other's line — verified with a local sed dry run against the real file before writing this. README: drop the two spots that hardcoded both branches' versions together (JupyterLab intro line, wheel-filename example) so there's nothing left for a human to keep in sync by hand; document the auto-sync behavior under "Releasing a new version". Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
release.yml: add a step that rewrites this branch's own pip/%pip install ...@vX.Y.Z[-staging] example lines in README.md to the version just resolved, then commits (with [skip ci]) and pushes if anything changed. main's run only touches the plain @vX.Y.Z lines (matched by the trailing quote), staging's only the -staging-suffixed ones, so a run on one branch can never clobber the other's line — verified with a local sed dry run against the real file before writing this.
README: drop the two spots that hardcoded both branches' versions together (JupyterLab intro line, wheel-filename example) so there's nothing left for a human to keep in sync by hand; document the auto-sync behavior under "Releasing a new version".