ci: Automate updating README when releasing - #257
Draft
anelson wants to merge 1 commit into
Draft
Conversation
I noticed that the README referred to old releases, because there's no automated mechanism to update it when we make a new release. This is an attempt to incorporate that automation as part of the existing release-plz workflow that updates the changelog and Cargo.toml version numbers. I haven't tested it yet; it needs to be committed and run in GHA in order to see if it works. - Added release.toml using cargo-release to synchronize exactly one README installer-version reference with the cgx package version. - Pinned cargo-release 1.1.3 in CI. - Added README version validation to regular and release-plz PR checks. - Updated release-plz PR generation to amend and safely force-push README updates. - Updated the installer example from v0.0.10 to v0.1.0. - Verified with just precommit, just xwin-check, and just xmac-check.
anelson
force-pushed
the
ci/automate-readme-updates-on-release
branch
from
August 21, 2026 10:59
ebcdb9c to
9cc0daa
Compare
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.
I noticed that the README referred to old releases, because there's no automated mechanism to update it when we make a new release. This is an attempt to incorporate that automation as part of the existing release-plz workflow that updates the changelog and Cargo.toml version numbers.
I haven't tested it yet; it needs to be committed and run in GHA in order to see if it works.
Closes #181