Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.22 KB

RELEASE.md

File metadata and controls

68 lines (49 loc) · 2.22 KB

How to make a release

dask-gateway and dask-gateway-server are packages available on PyPI and conda-forge, and dask-gateway is a Helm chart available at helm.dask.org which is both a user facing website and a Helm chart repository by having an index.yaml file read by helm the CLI linking to packaged Helm charts.

These are instructions on how to make a release.

Pre-requisites

Steps to make a release

  1. Refreeze Dockerfile.requirements.txt files by running the refreeze workflow and merging created PRs.

  2. 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=2 dask/dask-gateway
  • Visit and label all uncategorized PRs appropriately with: maintenance, enhancement, new, breaking, bug, or documentation.
  • Generate a list of PRs again and add it to the changelog
  • Highlight breaking changes
  • Summarize the release changes

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

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

  2. 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 the PyPI packages and Helm chart.

  3. Following the release to PyPI, an automated PR should arrive to conda-forge/dask-gateway-feedstock with instructions.