fix(docs): what cutting v0.1.0 turned up - #179
Merged
Merged
Conversation
willkg
force-pushed
the
release-fixes
branch
from
September 21, 2026 00:51
b31f7ab to
a16b499
Compare
This was referenced Sep 21, 2026
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
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.
Everything
v0.1.0turned up by actually being cut. The release process worked, and the documentation of it was wrong in four places — three of which only a real release could expose.What the release proved
v0.1.0shipped, andbrew install markfluenceworks. The shipped binary reportsmarkfluence 0.1.0 (1d0a2d0, 2026-09-20), so the ldflags stamp lands correctly on the real artifact — which was the last thing in #175 that could only be verified by doing it.brew trustis required, and nothing said soThe install instructions were incomplete. Homebrew will not load a cask from a non-official tap until the tap is trusted, so
brew tapfollowed bybrew installfails on a clean machine.brew trust mozilla/markfluencegoes between them.This is the kind of thing no amount of reading the goreleaser config would have surfaced — it is a property of Homebrew's handling of third-party taps, not of what we generate.
The verify step downloaded into the repository root
Step 6 said
mkdir tmpand then rangh release downloadwith nocd, so the archive,checksums.txtand the extracted binary all landed in the repo root, and therm -rf tmpat the end removed an empty directory and left them behind. Nowpushd tmp/popd, which also returns you to where you started — better than thecd "$(mktemp -d)"it replaced, which stranded you in/var/folders/…./tmp/is added to.gitignore, because the runbook now tells you to create a directory of untracked files — one of them a binary — inside the repository.And
gh release downloadis now inside the&&chain. It was on its own line, so a failed download did not stop the verification: it went on to verify whatever was already in the directory. That is not hypothetical — it happened while testing this, where a stale archive from a previous attempt verifiedOKand printed a version that was right only by luck. On a version bump it would confirm the previous release. Same class of bug as the unchainedsha256sumfixed in #177.The step was then re-run end to end against the real
v0.1.0release, which is where the version stamp above comes from.Release notes are not hard-wrapped
GitHub renders newlines in a release body as line breaks, so a paragraph wrapped at 80 columns renders ragged. Recorded in the runbook next to the
gh release editcommand, since that is where someone is standing when it matters.CLAUDE.mdrecords the release workflowAn omission from #177: the Build/distribution section enumerated the build tooling and said nothing about
.github/workflows/release.yml, which CLAUDE.md's own rule requires. It now covers the four things that would otherwise have to be re-derived from the workflow file:v*.*.*trigger, and why a barev*breaks once Ship markfluence as a reusable GitHub Action #29's moving major tag existsmake checkagainst the tagged commit, since a tag can be pushed at any commitprerelease: autois required rather than default — with why the gap was easy to miss, since the cask is correctly skipped for an RC by a different mechanismcontents: writebut deliberately notpull-requests: write, with the ruleset reasonPlus a pointer to
docs/releasing.mdas the runbook, and a note that namingarchives.filesis what makes the archive flat — which is why the Linux install instructions extract a single member rather than the whole thing.Also
The two "no release has been cut yet" admonitions are gone from
README.mdanddocs/releasing.md, since one has been. That was the last item on #175's closing checklist; the issue should be closeable once this lands.Some of the runbook's prose is tightened and a few explanatory paragraphs become
[!NOTE]blocks, which is presentational.