docs(readme): describe the source version without calling it a candidate - #217
Merged
Merged
Conversation
The README's badge and status line called the version in source a release candidate. make bump writes that when the version moves, and it stays true only until the release is promoted: 1.2.2 and 1.2.3 were both published while the front page still called them candidates. The badge now reads version-vX.Y.Z, and the status line says the version is the newest in source and points to the Releases page for what is downloadable, which holds before and after promotion. make bump's README anchors, its self-test, the README lockstep test, and the release checklist follow the new wording.
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.
Why
The README's badge and
## Statusline called the version in source a release candidate:make bumpwrites that when the version moves. It stays true only until the release is promoted, so 1.2.2 and 1.2.3 were both published while the repository's front page still called them candidates.Only changing the words to "released" would have broken the next release.
make bumpanchors on--candidate-orangeandis the current release candidateand refuses to write anything when an anchor stops matching. Flipping the wording after each release would also mean a second docs PR every time.What changed
Wording that holds before and after promotion:
version-v1.2.3-blueinstead ofstatus-v1.2.3--candidate-orange.The tooling follows the new wording:
scripts/bump-version.sh: the README badge and status sentence anchors, the self-test's expected strings, and its moved-anchor recovery case.Tests/AppStoreReadinessTests.readmeStatusMatchesTheProjectVersion: looks forversion-v<MARKETING_VERSION>.docs/RELEASING.md: the checklist names the version badge.Validation
make bump-check: the self-test passes. It runsmake bumpagainst copies of the real files, so the new anchors are proven against this README.main's README and the new anchors, the self-test fails, so a stale wording cannot slip through.shellcheck --severity=warning scripts/bump-version.sh,make lint,make hygiene,git diff --check.make test: CLI 227, domain 125, rendering 51, repository 128, unit 1750, all passing.