Skip to content

Commit c209191

Browse files
docs: reframe rc-first as convention, not invariant
The release workflow dispatches by tag name alone; a maintainer can push vX.Y.Z directly and the workflow will publish to PyPI without consulting any prior -rc tag. The intro paragraph read as if the rc-first flow were automation-enforced, which it isn't. Reframed the intro to make clear that rc-first is a maintainer-side convention carried by the pre-release checklist, not a property of the workflow.
1 parent 9f81f21 commit c209191

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

RELEASING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
How to cut a release of `openarmature`. For maintainers.
44

5-
Every release goes through TestPyPI before PyPI. The release workflow
6-
(`.github/workflows/release.yml`) is tag-driven: tag pushes are the only
7-
trigger; nothing else publishes.
5+
Releases go through TestPyPI before PyPI **by convention**. The
6+
workflow (`.github/workflows/release.yml`) is tag-driven and dispatches
7+
by tag name; it does not enforce that an rc preceded a real-release
8+
tag. Pushing `v0.7.0` directly publishes to PyPI without consulting
9+
any prior `-rc` tag, so the rc-first flow is a maintainer-side
10+
discipline carried by the pre-release checklist below.
811

912
## The release path: rc first, then real
1013

0 commit comments

Comments
 (0)