Skip to content

Add release checklist - #223

Merged
ywangd merged 2 commits into
ywangd:mainfrom
pquentin:release-docs
Jan 31, 2026
Merged

Add release checklist#223
ywangd merged 2 commits into
ywangd:mainfrom
pquentin:release-docs

Conversation

@pquentin

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread .github/PULL_REQUEST_TEMPLATE/release.md Outdated
export REMOTE=origin
git checkout main
git pull $REMOTE main
git tag -s -a "$VERSION" -m "Release: $VERSION"

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

The above says

Squash merge the release pull request with message "Release <VERSION>"

while we have "Release: $VERSION" (note the colon) here. Is this difference important?
Also, since we create an annotated tag here, is it still important to have the message for the merge commit?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

We can definitely use the same wording for the tag and the commit, but the difference isn't important.

I don't understand the question about the annotated tag, sorry.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for explaining.

Unlike a lightweight tag, an annotated tag (created with -a) has its own independent metadata, such as commit message, so that it does not rely on the commit message of the actual commit it points to. Yeah I agree it's not really important here.

Comment thread AUTHORS.rst
Co-authored-by: Yang Wang <ywangd@gmail.com>
@ywangd
ywangd merged commit 2111c76 into ywangd:main Jan 31, 2026
5 checks passed
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