Update release docs to match the automated publish pipeline#40
Merged
Conversation
docs/releasing.md and docs/versioning.md described crates.io publishing and the Homebrew formula update as manual post-CI steps requiring a local crates.io login and a tap checkout. The release-artifacts workflow has publish-crates and update-homebrew jobs that do both via repo secrets, and release.sh only bumps, tags, pushes and watches CI. Also corrects the binary count (the workflow builds 5 targets, not 4). Co-Authored-By: Claude Fable 5 <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.
Noticed while cutting v3.3.0:
docs/releasing.mdanddocs/versioning.mddescribe crates.io publishing and the Homebrew formula update as manual post-CI steps requiring a local crates.io login and ahomebrew-alliumcheckout. The release-artifacts workflow has hadpublish-cratesandupdate-homebrewjobs doing both via repo secrets (CARGO_REGISTRY_TOKEN,HOMEBREW_TAP_TOKEN), andrelease.sh's own completion message already says so — the docs lagged.releasing.md: publishing described as fully automated; artifact table moves crates.io and Homebrew from "Release script" to "CI"; prerequisites reduced togh+cargoon PATH; the old manual publish steps reframed as fallbacks for failed CI publish jobs; stale "would also let the Homebrew update run automatically" forward-reference dropped (it does); binary count corrected to 5 targets.versioning.md: major-version checklist item 4 no longer instructs a manualupdate-homebrew-formula.shrun.Doc-only change, verified against
.github/workflows/release-artifacts.ymlandscripts/release.shas exercised by the live v3.3.0 release.🤖 Generated with Claude Code