chore: keep install-snippet versions in sync via release-please - #87
Merged
Conversation
Register the READMEs and docs install snippets as release-please extra-files and wrap each version in invisible HTML-comment markers, so the standing Release PR bumps them atomically with gradle.properties. Reconcile all snippets to the published 5.2.0 (they had drifted to 6.0.0 / 3.0.0).
emaarco
enabled auto-merge (squash)
August 19, 2026 13:36
Contributor
|
Test Coverage
|
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.
What & why
Version numbers were scattered and contradictory: the authoritative version (
gradle.properties=5.2.0, matching tagv5.2.0) was bumped by release-please, but every hand-maintained install snippet had drifted — the top-level README and all docs said6.0.0, the module READMEs said3.0.0.Root cause: release-please only listed
gradle.propertiesinextra-files, so nothing else stayed in sync.Changes
docs/getting-started/*,docs/validate/*,docs/surface/json.md).<!-- x-release-please-start-version -->/<!-- x-release-please-end -->HTML-comment markers (outside the code fence, so nothing renders in the copy-paste block).genericextra-filesinrelease-please-config.json, so the standing Release PR now bumps them atomically withgradle.properties.Version-specific migration guides and ADRs (e.g.
docs/changelog/v6.md, prose like "Since 6.0.0 the format …") are intentionally left untouched.Verification
release-please-config.jsonremains valid JSON.6.0.0/3.0.0left in install snippets (only the intentional historical prose reference).release-please.ymlworkflow_dispatchdry run).