How to make a release
jupyter-server-proxy is a package available on PyPI and conda-forge.
These are instructions on how to make a release.
Pre-requisites
- Push rights to github.com/jupyterhub/jupyter-server-proxy
- Push rights to conda-forge/jupyter-server-proxy-feedstock
Steps to make a release
Create a PR updating
labextension/yarn.lockand continue only when its merged.This helps us avoid leaving known vulnerabilities are unfixed. To do this, delete the file and manually perform the the
build diststep in the.github/workflows/publish.yamlworkflow'sbuildjob as summarized below.# git clean -xfd can be needed to ensure labextension/yarn.lock # gets re-created during pyproject-build rm labextension/yarn.lock pip install --upgrade pip build pyproject-buildCreate a PR updating
docs/source/changelog.mdwith github-activity and continue only when its merged.Checkout main and make sure it is up to date.
git checkout main git fetch origin main git reset --hard origin/mainUpdate the version, make commits, and push a git tag with
tbump.pip install tbump tbump --dry-run ${VERSION} # run tbump ${VERSION}Following this, the CI system will build and publish a release.
Reset the version back to dev, e.g.
4.0.1-0.devafter releasing4.0.0.tbump --no-tag ${NEXT_VERSION}-0.devFollowing the release to PyPI, an automated PR should arrive to conda-forge/jupyter-server-proxy-feedstock with instructions.