Repository navigation
fix: regenerate the README inside the version-packages script - #185
Merged
Merged
Conversation
The post-changesets checkout step failed because the changesets action leaves the working tree dirty with the version bumps it commits itself; checking out changeset-release/main then aborts. Running generate-readme-codemods as the last stage of version-packages puts the README into the same version commit the action pushes, which is also where it belongs.
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
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.
Summary
The Version Packages PR was missing its README update because the follow-up
"Sync README" step could never run.
The changesets action runs the version script in the job's working tree and
commits the resulting diff itself. The old post-action step then tried to
git checkout changeset-release/mainagainst that dirty tree and aborted("local changes would be overwritten"). Regenerating the README as the last
stage of
version-packagesputs it into the same version commit the actionpushes, so changeset consumption, version bumps, and the README land in one
commit. The broken checkout step is deleted.
Evidence
PR" with
error: Your local changes to the following files would be overwritten by checkout.After:
yarn version-packagesverified end-to-end in a throwawayworktree (all 10 changesets consumed, 12
codemod.yamlversions synced,README regenerated, exit 0).
Merge Danger
Door: two-way (single revert).
Blast Radius: release pipeline only — no codemod or package changes.