RELEASE.md

How to make a release

binderhub-service is a Helm chart available in the Helm chart repository https://2i2c.org/binderhub-service.

Pre-requisites

• Push rights to 2i2c-org/binderhub-service

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 2i2c-org/binderhub-service

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. 1.1.0-0.dev after releasing 1.0.0

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