Skip to content

ci: publish a GitHub Release (not a bare tag) + clarify record-release step#281

Merged
sudsali merged 1 commit into
masterfrom
docs/clarify-record-release-step
Jul 8, 2026
Merged

ci: publish a GitHub Release (not a bare tag) + clarify record-release step#281
sudsali merged 1 commit into
masterfrom
docs/clarify-record-release-step

Conversation

@sudsali

@sudsali sudsali commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #279 addressing review feedback, plus a release-convention fix.

Changes

1. Publish a GitHub Release, not a bare tag. python-deequ historically ships GitHub Releases (v1.1.0…v1.4.0, 2.0.0b1), but the workflow created only a bare git tag. Switch the post-publish step to gh release create v${VERSION} --target ${RELEASE_SHA} --generate-notes, which creates the tag and the Release page in one call, pinned to the published commit, after the PyPI upload. Idempotent (skips if the release already exists).

2. Clarify the post-publish version step (per @kyraman's review on #279): the job sets master to the just-released version rather than advancing to a next dev version (matching awslabs/deequ). Renamed Bump version and open PRRecord release version in master and open PR, with a comment stating it does NOT advance to a next-dev version.

Notes

  • Comment/naming + one workflow-step change; no change to the publish, versioning, or approval behavior.
  • Not backfilling a Release for 1.6.0: its predecessor 1.5.0 shipped with neither tag nor release, so retroactively singling out 1.6.0 adds no value — the fix is forward-looking.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

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-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found.


Generated by AI (model: us.anthropic.claude-opus-4-8, prompt: 295226dd) — may not be fully accurate. Reply if this doesn't help.
Reviewed by Shadow · github.com/sudsali/shadow

@sudsali sudsali merged commit cea2156 into master Jul 8, 2026
12 checks passed
@sudsali sudsali changed the title docs: clarify post-publish step records the released version ci: publish a GitHub Release (not a bare tag) + clarify record-release step Jul 8, 2026
sudsali added a commit that referenced this pull request Jul 9, 2026
python-deequ historically ships GitHub Releases (v1.1.0..v1.6.0), not bare
tags. Replace the 'git tag + push' step with 'gh release create v${VERSION}
--target ${RELEASE_SHA} --generate-notes', which creates the tag AND the
Release page in one call, pinned to the published commit, after the PyPI
upload. Idempotent (skips if the release already exists).

Note: this change was intended for #281 but landed on that branch after it had
already merged, so it never reached master — hence this follow-up PR.
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