Skip to content

Commit 7611de7

Browse files
committed
docs(releasing): scope what --ref main actually picks up
"any fix landed since the tag" was too broad. Both workflows check out ref: ${{ inputs.tag || github.ref_name }}, so only the workflow YAML comes from main -- everything it runs comes from the tag, including scripts/extract-changelog.py. That is the right design, but the loose wording invites the opposite conclusion for the exact failure this section covers: if that script is what broke, a dispatch re-run does not pick up its fix.
1 parent 4d65413 commit 7611de7

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎RELEASING.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,10 @@ gh workflow run "Publish to PyPI" --ref main -f tag=vX.Y.Z
4545
gh workflow run "GitHub Release" --ref main -f tag=vX.Y.Z
4646
```
4747

48-
`--ref main` selects the workflow *definition* (so it picks up any fix landed
49-
since the tag); the `tag` input selects what gets built and released. The two
50-
refs serve different purposes, which is why they can differ.
48+
`--ref main` selects the workflow *definition*, so a fix to the workflow file
49+
itself is picked up; everything it runs — including `scripts/extract-changelog.py`
50+
— still comes from the tag, since that is what is being built and released. The
51+
two refs serve different purposes, which is why they can differ.
5152

5253
A version is only spent once PyPI has accepted an upload. If the publish failed
5354
before that, the same version can still be published — check with

0 commit comments

Comments
 (0)