Skip to content

Add automated release workflow - #5894

Open
KoolADE85 wants to merge 1 commit into
mainfrom
chore/release-automation
Open

KoolADE85 wants to merge 1 commit into
mainfrom
chore/release-automation

Conversation

@KoolADE85

Copy link
Copy Markdown
Contributor

This PR automates the publishing of a tag to a Github release and to PyPi.

@KoolADE85 KoolADE85 added the no-changelog A changelog entry is not required for this PR label Nov 19, 2026

@camdecoster camdecoster 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.

I left you a few comments, but this looks good overall.

TAG: ${{ inputs.tag }}

jobs:
validate:

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.

Should we add a check in here to make sure this only runs on main?

Comment thread RELEASE.md
```
- Create a GitHub pull request from `release-X.Y.Z` to `main` and wait for CI to be green
- On the release branch, create and push a tag for the release:
- Create a GitHub pull request from `release-X.Y.Z` to `main`, wait for CI to be green, and merge it

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.

Suggested change
- Create a GitHub pull request from `release-X.Y.Z` to `main`, wait for CI to be green, and merge it
- Create a GitHub pull request from `release-X.Y.Z` to `main`, wait for CI to be green and approval, and merge it

Comment thread RELEASE.md

The accepted tag shapes are `vX.Y.Z`, `vX.Y.ZaN`, `vX.Y.ZbN` and `vX.Y.ZrcN`. Anything else (`.dev`, `.post`, `-rc.1`) is rejected before anything is built.

### Manual QA in Jupyter

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.

Could you add a section describing what to do if QA fails?

with:
name: notes
path: .
- name: Create the draft release

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.

I'd argue that we should skip the draft and just publish the release. We're already publishing to PyPI. In for a penny, in for a dollar.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog A changelog entry is not required for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants