Skip to content

Commit b7c57e6

Browse files
committed
docs: clarify the post-publish step records the released version
Address review feedback (#279): the post-publish job sets master to the just-released version rather than advancing to a next dev version (matching awslabs/deequ). Rename the step 'Bump version and open PR' -> 'Record release version in master and open PR' and note the intent in the comment, so 'bump' isn't read as a next-dev bump.
1 parent dc20734 commit b7c57e6

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

.github/workflows/publish.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name: Publish to PyPI
22

33
# Manually triggered release, mirroring awslabs/deequ's publish flow: the
44
# operator supplies the release version, the workflow sets it, builds, and
5-
# publishes to PyPI, then tags the release and opens a follow-up PR that bumps
6-
# the version in the repo. The PyPI token is never stored in GitHub — it is
5+
# publishes to PyPI, then tags the release and opens a follow-up PR that records
6+
# the released version in the repo. The PyPI token is never stored in GitHub — it is
77
# fetched at run time from AWS Secrets Manager via OIDC and passed to Poetry
88
# through an env var.
99

@@ -173,9 +173,11 @@ jobs:
173173
git push origin "v${VERSION}"
174174
fi
175175
176-
- name: Bump version and open PR
177-
# Idempotent: skip if the bump branch/PR already exist or master is
178-
# already at this version (e.g. a re-run after a partial failure).
176+
- name: Record release version in master and open PR
177+
# Records the just-released version in the repo (sets pyproject +
178+
# __init__ to ${VERSION}); it does NOT advance to a next dev version.
179+
# Idempotent: skip if the branch/PR already exist or master is already
180+
# at this version (e.g. a re-run after a partial failure).
179181
run: |
180182
BRANCH_NAME="bump-version-${VERSION}"
181183
if git ls-remote --exit-code --heads origin "${BRANCH_NAME}" >/dev/null 2>&1; then

0 commit comments

Comments
 (0)