Skip to content

Fold the shipping checklist into docs/release.md - #22

Merged
imanimanyara merged 2 commits into
mainfrom
docs/fold-shipping-checklist-into-release
Oct 5, 2026
Merged

imanimanyara merged 2 commits into
mainfrom
docs/fold-shipping-checklist-into-release

Conversation

@imanimanyara

Copy link
Copy Markdown
Member

The org keeps a single shipping checklist outside the repositories, so docs/shipping-checklist.md is removed. Its generic steps are covered by the org-wide checklist; everything specific to shimkit moves to docs/release.md.

What moved

Old checklist item New home in docs/release.md
Status note (GitHub Release live since v0.5.0, PyPI restored v0.11.0) intro note + Release readiness row 1
1.1-1.3, 1.6, 1.7, 2.1-2.3, 6.1, 7.1, 7.2 (repo setup, CI jobs, gates, Dependabot, Codecov, tool docs) Gates a release depends on
1.4, 7.5 (release workflow, attestation verify) What release.yml does (diagram now includes verify-attestation)
1.5 (container removed in v0.2.2) intro note
1.8 branch protection Release readiness row 2, corrected to done: active ruleset, checked 2026-10-05
2.4 pypi environment, OIDC sub Release readiness row 3
4.1, 4.2 (PyPI account, trusted-publisher fields) rows 4-5 + PyPI trusted-publisher setup
4.3 TestPyPI row 6
5.1, 5.2 first upload + pip install shimkit row 7
invalid-publisher history, 404 on pypi.org Why PyPI has never received an upload
5.3 + gh workflow run release.yml --repo simtabi/shimkit --ref v0.19.0 Publishing past tags after the publisher exists
Phase 3 Homebrew tap Homebrew tap (abandoned)
7.3 mkdocs, 7.4 CITATION.cff Optional and future
Critical path summary Release readiness

Every backticked identifier and URL in the old file appears in docs/release.md, except the self-reference to docs/release.md, the status word optional, and the critical-path diagram, which was renumbered to match the new table.

The old release.md ship table described a bump-homebrew-tap job that release.yml no longer has; that now sits under the abandoned tap section. Links in the README index, overview.md, validation-scope.md, onboarding.md and docs/plans/ point at docs/release.md. CHANGELOG history and prompt.md mentions are left as they are.

The org keeps one shipping checklist outside the repositories, so the
per-project copy goes. Its generic steps are already covered there;
everything specific to shimkit moves to docs/release.md as a
release-readiness table, the invalid-publisher history, the
dispatch-on-tag republish recipe, the CI gates, the verify-attestation
job, the abandoned Homebrew tap and the optional future items.

The branch-protection item was still recorded as pending. An active
ruleset on main requires a pull request and every CI check, so it is
recorded as done, with the date it was checked. The old release.md
ship table also described a bump-homebrew-tap job that release.yml no
longer has; that now sits under the abandoned tap section.
Copilot AI balanced review requested due to automatic review settings October 5, 2026 11:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

The page told readers to push main and the tag together, which bypasses
the pull-request ruleset on main.
@imanimanyara
imanimanyara merged commit 9847ffa into main Oct 5, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants