Add nox session for creating release commits #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Maegereg
approved these changes
Jul 16, 2025
Maegereg
reviewed
Jul 16, 2025
e5be8a0 to
b4d71d1
Compare
Maegereg
reviewed
Jul 21, 2025
Adds a new nox session, `make_release`, which takes a version number as an argument, updates the changelog, and pushes a release branch and tag for that version based on the current commit. All of the interactions with git are automated, but creating a PR to merge the release branch back to main requires a manual step for now, as AFAIK there's not a nice way to do it without also requiring GitHub credentials. There are a few sanity checks in place to make sure this release process doesn't do anything bad: - It will refuse to do anything if the repo is dirty or has untracked files, as these changes could be lost or unintentionally included in the release. - It fetches from `origin` and checks that the release tag/branch being created doesn't already exist. There is technically a narrow window where two people could make the same release simultaneously, but GitHub should reject the second push anyway. - It will only allow releases when the current branch is `main`; prerelease versions skip this check at present, as we could potentially want to make dev releases on side branches. If we in future want to enable making releases from stable branches (to patch old versions), that should be straightforward to exclude from this check as well.
b4d71d1 to
38edbfd
Compare
This was referenced Jul 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new nox session,
make_release, which takes a version number as an argument, updates the changelog, and pushes a release branch and tag for that version based on the current commit. All of the interactions with git are automated, but creating a PR to merge the release branch back to main requires a manual step for now, as AFAIK there's not a nice way to do it without also requiring GitHub credentials.There are a few sanity checks in place to make sure this release process doesn't do anything bad:
originand checks that the release tag/branch being created doesn't already exist. There is technically a narrow window where two people could make the same release simultaneously, but GitHub should reject the second push anyway.main; prerelease versions skip this check at present, as we could potentially want to make dev releases on side branches. If we in future want to enable making releases from stable branches (to patch old versions), that should be straightforward to exclude from this check as well.We don't yet have a pipeline in place for automatically making a release when a tag is pushed, but this is a step towards mostly-automated releases.