From b7c57e6ab0be029d1d1bd5a5f6bdfd19b6aae691 Mon Sep 17 00:00:00 2001 From: Sudhanshu Sali Date: Wed, 8 Jul 2026 13:05:43 -0400 Subject: [PATCH] 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. --- .github/workflows/publish.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a345d68..aa56083 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -2,8 +2,8 @@ name: Publish to PyPI # Manually triggered release, mirroring awslabs/deequ's publish flow: the # operator supplies the release version, the workflow sets it, builds, and -# publishes to PyPI, then tags the release and opens a follow-up PR that bumps -# the version in the repo. The PyPI token is never stored in GitHub — it is +# publishes to PyPI, then tags the release and opens a follow-up PR that records +# the released version in the repo. The PyPI token is never stored in GitHub — it is # fetched at run time from AWS Secrets Manager via OIDC and passed to Poetry # through an env var. @@ -173,9 +173,11 @@ jobs: git push origin "v${VERSION}" fi - - name: Bump version and open PR - # Idempotent: skip if the bump branch/PR already exist or master is - # already at this version (e.g. a re-run after a partial failure). + - name: Record release version in master and open PR + # Records the just-released version in the repo (sets pyproject + + # __init__ to ${VERSION}); it does NOT advance to a next dev version. + # Idempotent: skip if the branch/PR already exist or master is already + # at this version (e.g. a re-run after a partial failure). run: | BRANCH_NAME="bump-version-${VERSION}" if git ls-remote --exit-code --heads origin "${BRANCH_NAME}" >/dev/null 2>&1; then