Pin the cargo-readme version CI installs - #321
Merged
Merged
Conversation
`check/readme` byte-compares the generated README, so an unpinned install fails the build whenever cargo-readme changes its output, with nothing in the diff to explain it. That has happened once already: 3.4.0 dropped the hidden `# pub fn main` lines 3.3.3 kept, and the fix was a README regeneration with no source change. Pin CI to 3.4.0, which is what generated the committed README, and point the two documented local-install commands at the same version so a contributor does not drift onto a newer one.
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.
make check/readmebyte-compares the generated README against the committed one, so an unpinnedcargo install cargo-readmefails the build whenever cargo-readme changes its output, on a PR whose diff contains nothing to explain it.That is not hypothetical: 3.4.0 emits plain
rustfences and drops the hidden# pub fn mainlines 3.3.3 kept, and the fix was a README regeneration with no doc-comment change.--locked. 3.4.0 is what generated the committed README, so no regeneration is needed here.AGENTS.md,CONTRIBUTING.md) at the same version, since a contributor copying them would otherwise install the latest and produce a README that fails CI.check/readmetarget, so it does not take reading the workflow to find.Moving the pin later is documented in
specs/design/0049-pin-cargo-readme.md: regenerate, eyeball the diff, and commit the README with the version bump together socheck/readmenever sees a mismatch.