Skip to content

Update notes on making a release #45

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
mdickinson merged 3 commits into from
Nov 2, 2025
Merged

Update notes on making a release #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08461f2
Attempt to fix publish action
mdickinson Nov 2, 2025
6d7c6ba
Revert changes
mdickinson Nov 2, 2025
e6964ad
Remove temporary pull_request trigger
mdickinson Nov 2, 2025
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
11 changes: 8 additions & 3 deletions DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,14 @@ Steps to make a release:
Make a PR for the version bump.
- Ensure that the lockfile has been updated. (Not necessary if you used `uv version`.)
- Prepare release notes in a (temporary) markdown file.
- Tag the release commit with an annotated tag matching the version (e.g. `git tag -a
2.3.4`); include the prepared release notes in the commit message body.
- Tag the release commit with an annotated tag matching the version:

git tag -a $(uv version --short)

Include the prepared release notes in the commit message body.
- Push the tag with `git push --tag`
- Go to the GitHub releases page: https://github.com/mdickinson/simplefractions/releases
- Create a new release, using the previously prepared release notes.
- Create a new release ("Draft a new release"), using the previously-prepared release
notes and a release title of the form "simplefractions n.n.n".
- Double-check that the release workflow succeeded and that the new release is present
on PyPI at https://pypi.org/project/simplefractions.