Skip to content

Use annotated tags for releases #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefanv merged 1 commit into from
Sep 19, 2025
+8 −5
Merged

Use annotated tags for releases #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Example `version number`
export REPO="spin"
export LOG="CHANGELOG.md"

- Autogenerate release notes
- Autogenerate release notes:

changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION} --out ${VERSION}.md

- Put the output of the above command at the top of `CHANGELOG.md`
- Put the output of the above command at the top of `CHANGELOG.md`:

cat ${VERSION}.md | cat - ${LOG} > temp && mv temp ${LOG}

Expand All @@ -37,7 +37,7 @@ Example `version number`

- Tag the release in git:

git tag -s v${VERSION} -m "signed ${VERSION} tag"
git tag -a -s v${VERSION} -m "signed ${VERSION} tag"

If you do not have a gpg key, use -u instead; it is important for
Debian packaging that the tags are annotated
Expand All @@ -49,11 +49,14 @@ Example `version number`
where `origin` is the name of the `github.com:scientific-python/spin`
repository

- Review the github release page:
- Review the github tags page:

https://github.com/scientific-python/spin/tags

- Update `version` in `spin/__init__.py`.
and create a release. Paste the content of "${VERSION}.md" into the
release notes, apart from the title line starting with `#`.

- Update `version` in `spin/__init__.py` to `0.Xrc0.dev0`.

- Commit changes:

Expand Down
Loading