From 63bfeef3bc44647972a741a1083c2eb3be25b612 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Fri, 2 Sep 2022 10:03:07 +0200 Subject: [PATCH] Simplify release docs As discussed with @rabernat and @jakirkham, in order to encourage more folks with push rights to release zarr-python, this change makes it clear that a release is possible completely from within GitHub. The previous instructions will continue to work but have been removed to avoid confusion. --- docs/contributing.rst | 29 +++++++++++++++-------------- docs/release.rst | 2 +- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 2fbfd92a7a..64e017d17f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -335,22 +335,23 @@ Release procedure .. note:: Most of the release process is now handled by github workflow which should - automatically push a release to PyPI if a tag is pushed. + automatically push a release to PyPI if a tag is pushed. -Checkout and update the main branch:: +Before releasing, make sure that all pull requests which will be +included in the release have been properly documented in +`docs/release.rst`. - $ git checkout main - $ git pull +To make a new release, go to +https://github.com/zarr-developers/zarr-python/releases and +click "Draft a new release". Choose a version number prefixed +with a `v` (e.g. `v0.0.0`) and set the description to: -Verify all tests pass on all supported Python versions, and docs build:: +``` +See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0 +``` - $ tox +replacing the correct version numbers. For pre-release versions, +the URL should omit the pre-release suffix, e.g. "a1" or "rc1". -Tag the version (where "X.X.X" stands for the version number, e.g., "2.2.0"):: - - $ version=X.X.X - $ git tag -a v$version -m v$version - $ git push origin v$version - -Create a GitHub release in order to generate the Zenodo DOI and -review the automatically generated zarr-feedstock PR. +Be sure to review and merge the https://github.com/conda-forge/zarr-feedstock +pull request that will be automatically generated. diff --git a/docs/release.rst b/docs/release.rst index 2582c34e04..82f992495f 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -16,7 +16,7 @@ Release notes 2.13.0 ------ .. warning:: - Pre-release! Use `pip install --pre zarr` to evaluate this release. + Pre-release! Use :command:`pip install --pre zarr` to evaluate this release. Major changes ~~~~~~~~~~~~~