docs(contributing): document the tool-version upgrade workflow (#498)#525
Merged
Conversation
CONTRIBUTING had no mention of the checksum_updater, so contributors hand-edited checksums and pins drifted silently — the original motivation for #498. Add an "Updating Tool Versions" section: the JSON registry is the source of truth (latest_version is the pin; no separate MODULE.bazel pin for managed tools), the update/validate/dry-run commands, the UrlPattern taxonomy (StandardTarball/SingleBinary, PerPlatformAsset, UniversalWasm+AssetExists), how to register a new tool, and a signing-path caveat for wsc. Closes the #498 documentation item (item 5). Items 1-2 (universal-wasm pattern + asset-existence filter) shipped in #502; item 4 (wsc PerPlatformAsset + 0.9.2 bump) in #524. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Adds an "Updating Tool Versions" section to
CONTRIBUTING.md. The file had no mention of thechecksum_updaterat all — the silent gap that let pins drift and motivated #498.Documents:
checksums/tools/*.json) is the source of truth;latest_versionis the pin (no separateMODULE.bazelpin for registry-managed tools).update-all --dry-run,update --tools …,validate --all,GITHUB_TOKENfor rate limits.UrlPatterntaxonomy —StandardTarball/SingleBinary,PerPlatformAsset(mixed extensions),UniversalWasm+AssetExists.ToolConfig::new().pulseengine/sigil): the updater can produce the registry change mechanically, but a wsc bump changes signing and needs a signing build/test + maintainer review before merge.Closes the #498 tail
Item 5 (docs). With #502 (universal-wasm pattern + asset-existence filter), #507 (PerPlatformAsset + null-name), and #524 (wsc wired + 0.9.2), every tracked tool is now auto-managed and the workflow is documented — #498 is fully addressed.
Docs-only; no code or build change.
🤖 Generated with Claude Code