docs(release): rewrite the playbook around CI-built releases - #213
Merged
Conversation
Releases are now built by .github/workflows/release.yml on a tag push, so the playbook no longer describes a laptop-built release: - §1 covers the rc.N -> final version sequence and why semver pre-release identifiers carry the whole candidate flow. - §4 keeps only what CI cannot do (license check, npm start spot check, green CI on the branch head). - §5 is the tag-driven build: job table, candidate pre-releases vs. final drafts, re-run semantics, the candidate loop, manual runs. - §6 downloads test artifacts from the GitHub Release instead of a LAN HTTP server, adds the separate-profile launch for every platform and the hash check against the release's manifests. - §7 publishes from the draft's assets so GitHub and freedom.baby serve identical bytes, then flips the draft; §8 merges (tag already pushed); §9 opens the next dev cycle. - Appendix A keeps the local mac/Linux/Windows build recipes as a fallback; Appendix B documents secrets, guards, re-runs, the channel pin and the first-run fixes for whoever maintains the workflow. Cross-references in windows-utm-build.md and better-sqlite3-prebuilds.js point at the appendix for the cross-build recipe.
6 tasks
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.
Summary
Releases are built by
.github/workflows/release.ymlsince #207/#210, but the playbook still described a laptop-built release (localnpm run dist, LAN HTTP server to move artifacts, tag last). This rewritesdocs/agent-playbooks/release-process.mdaround the actual flow:rc.1tag → public pre-release → smoke test → fix/bump loop → bare version + final changelog →v<version>tag → draft → publish.rc.N→ final sequence;npm version --no-git-tag-versioncaveat; why semver pre-release ids carry the candidate flow (artifact names, About, updater ordering, workflow behaviour).npm startspot check, green CI on the branch head.gh release download), hash check against the release'slatest-*.yml, separate-profile launch commands for macOS/Linux/Windows, one green candidate for all platforms.publish.channelpin, and the first-run fixes (adblock retry, bsdtar on Windows).Section numbers referenced from
release.ymlcomments (§1, §5, §6) keep their meaning.windows-utm-build.mdand the comment inscripts/better-sqlite3-prebuilds.jsnow point at Appendix A for the cross-build recipe.Related issue
Follows #207, #210, #211, #212.
Verification
npx prettier --checkon all three files;npx eslint scripts/better-sqlite3-prebuilds.js(comment-only change);git diff --check§Ncross-reference in the repo re-checked against the new numberingVisual changes
Not applicable.
Security and privacy
No change. Appendix B describes where the signing secrets live; no values.
AI assistance
Drafted by Claude Code from the release runs done today; the maintainer reviews and merges.