sneak/AutistMask
1
0
Fork 0
Code Issues 67 Pull Requests 3 Actions Packages Projects Releases Wiki Activity

docs: a release procedure from a green main to tagged, packaged, distributed artifacts #387

New Issue
Closed
opened 2026-09-21 09:19:21 +02:00 by clawbot · 1 comment
clawbot commented 2026-09-21 09:19:21 +02:00
Collaborator
Copy Link
Copy Source

README.md documents make package and says that tagging, CRX packing and any upload are the owner's alone, but nowhere does the repo say, in order, what turns a green main into a released 1.0.0. The person cutting the release should not have to reconstruct it from the Makefile and three README sections.

Definition of done

  • A docs/RELEASE.md (linked from README.md) states the release procedure as a numbered list a newcomer can follow: confirm main is green in CI, confirm the version in the three files matches the intended tag, make package from a clean checkout of that commit, verify SHA256SUMS, create the annotated tag vX.Y.Z on that commit, and then the per-browser distribution steps as decided in #386.
  • Each step names who performs it (owner-only steps are marked) and what the check is that it worked.
  • Every command in the document is verified against the Makefile and script/ as they are on next; a command that does not exist is not written.
  • Docs-only unit: no code or test changes. make fmt run; make check green.

model: claude-fable-5

`README.md` documents `make package` and says that tagging, CRX packing and any upload are the owner's alone, but nowhere does the repo say, in order, what turns a green `main` into a released 1.0.0. The person cutting the release should not have to reconstruct it from the Makefile and three README sections. ## Definition of done - [ ] A `docs/RELEASE.md` (linked from `README.md`) states the release procedure as a numbered list a newcomer can follow: confirm `main` is green in CI, confirm the version in the three files matches the intended tag, `make package` from a clean checkout of that commit, verify `SHA256SUMS`, create the annotated tag `vX.Y.Z` on that commit, and then the per-browser distribution steps as decided in https://git.eeqj.de/sneak/AutistMask/issues/386. - [ ] Each step names who performs it (owner-only steps are marked) and what the check is that it worked. - [ ] Every command in the document is verified against the `Makefile` and `script/` as they are on `next`; a command that does not exist is not written. - [ ] Docs-only unit: no code or test changes. `make fmt` run; `make check` green. model: claude-fable-5
clawbot added this to the 1.0.0 milestone 2026-09-21 09:19:21 +02:00
clawbot commented 2026-09-21 09:55:19 +02:00
Author
Collaborator
Copy Link
Copy Source

Opened #395 (base next).

Added docs/RELEASE.md, linked from the Release Artifacts section of README.md. It states the release procedure as a numbered list a newcomer can follow: confirm main is green in CI, confirm the one version in package.json and the two manifests matches the intended tag, make package from a clean checkout, verify SHA256SUMS, create the annotated tag vX.Y.Z, then distribute per browser. Each step names who performs it, marks the owner-only ones, and states the check that it worked.

Every repo command cited (make setup, make check, make package) exists on next; the tag, digest-verify and CRX-pack steps use standard git and sha256sum and the chrome --pack-extension line already in README.md. The per-browser distribution step is written as pending the owner's choice on #386, with the Firefox and Chrome options named and none presented as settled. Docs only: no code or test changes.

Model: opus-4-8

Opened https://git.eeqj.de/sneak/AutistMask/pulls/395 (base `next`). Added `docs/RELEASE.md`, linked from the Release Artifacts section of `README.md`. It states the release procedure as a numbered list a newcomer can follow: confirm `main` is green in CI, confirm the one version in `package.json` and the two manifests matches the intended tag, `make package` from a clean checkout, verify `SHA256SUMS`, create the annotated tag `vX.Y.Z`, then distribute per browser. Each step names who performs it, marks the owner-only ones, and states the check that it worked. Every repo command cited (`make setup`, `make check`, `make package`) exists on `next`; the tag, digest-verify and CRX-pack steps use standard `git` and `sha256sum` and the `chrome --pack-extension` line already in `README.md`. The per-browser distribution step is written as pending the owner's choice on https://git.eeqj.de/sneak/AutistMask/issues/386, with the Firefox and Chrome options named and none presented as settled. Docs only: no code or test changes. Model: opus-4-8
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
merge-ready
needs-checks
needs-rebase
needs-review
needs-rework
No labels
Milestone
No items
No Milestone 1.0.0
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/AutistMask#387