jupyterhub/RELEASE.md

How to make a release

jupyterhub is a package available on PyPI and conda-forge. These are instructions on how to make a release.

Pre-requisites

• Push rights to jupyterhub/jupyterhub
• Push rights to conda-forge/jupyterhub-feedstock

Steps to make a release

1. Create a PR updating docs/source/changelog.md with github-activity and continue only when its merged.

   pip install github-activity
   
   github-activity --heading-level=3 jupyterhub/jupyterhub
   

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

   git checkout main
   git fetch origin main
   git reset --hard origin/main
   

3. Update the version, make commits, and push a git tag with tbump.

   pip install tbump
   tbump --dry-run ${VERSION}
   
   tbump ${VERSION}
   

   Following this, the CI system will build and publish a release.

4. Reset the version back to dev, e.g. 2.1.0.dev after releasing 2.0.0

   tbump --no-tag ${NEXT_VERSION}.dev
   

5. Following the release to PyPI, an automated PR should arrive to conda-forge/jupyterhub-feedstock with instructions.