RELEASE.md

How to make a release

dockerspawner is a package available on PyPI. The PyPI release is done automatically by TravisCI when a tag is pushed.

For you to follow along according to these instructions, you need to have push rights to the dockerspawner GitHub repository.

Steps to make a release

1. Checkout main and make sure it is up to date.

   ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
   git checkout main
   git fetch $ORIGIN main
   git reset --hard $ORIGIN/main
   # WARNING! This next command deletes any untracked files in the repo
   git clean -xfd

2. Update docs/source/changelog.md and add it to the working tree.

   git add docs/source/changelog.md

   Tip: Identifying the changes can be made easier with the help of the executablebooks/github-activity utility.

3. Set the version_info variable in _version.py appropriately and make a commit.

   git add dockerspawner/_version.py
   VERSION=...  # e.g. 1.2.3
   git commit -m "release $VERSION"

   Tip: You can get the current project version by checking the latest tag on GitHub.

4. Create a git tag for the release commit.

   git tag -a $VERSION -m "release $VERSION"
   # then verify you tagged the right commit
   git log

5. Reset the version_info variable in _version.py appropriately with an incremented patch version and a dev element, then make a commit.

   git add dockerspawner/_version.py
   git commit -m "back to dev"

6. Push your two commits.

   git push $ORIGIN main --follow-tags