Skip to content

Commit ea7bb11

Browse files
authored
Simplify release docs (#1119)
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.
1 parent 1c464cb commit ea7bb11

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

docs/contributing.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -335,22 +335,23 @@ Release procedure
335335
.. note::
336336

337337
Most of the release process is now handled by github workflow which should
338-
automatically push a release to PyPI if a tag is pushed.
338+
automatically push a release to PyPI if a tag is pushed.
339339

340-
Checkout and update the main branch::
340+
Before releasing, make sure that all pull requests which will be
341+
included in the release have been properly documented in
342+
`docs/release.rst`.
341343

342-
$ git checkout main
343-
$ git pull
344+
To make a new release, go to
345+
https://github.com/zarr-developers/zarr-python/releases and
346+
click "Draft a new release". Choose a version number prefixed
347+
with a `v` (e.g. `v0.0.0`) and set the description to:
344348

345-
Verify all tests pass on all supported Python versions, and docs build::
349+
```
350+
See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0
351+
```
346352

347-
$ tox
353+
replacing the correct version numbers. For pre-release versions,
354+
the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
348355

349-
Tag the version (where "X.X.X" stands for the version number, e.g., "2.2.0")::
350-
351-
$ version=X.X.X
352-
$ git tag -a v$version -m v$version
353-
$ git push origin v$version
354-
355-
Create a GitHub release in order to generate the Zenodo DOI and
356-
review the automatically generated zarr-feedstock PR.
356+
Be sure to review and merge the https://github.com/conda-forge/zarr-feedstock
357+
pull request that will be automatically generated.

docs/release.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Release notes
1616
2.13.0
1717
------
1818
.. warning::
19-
Pre-release! Use `pip install --pre zarr` to evaluate this release.
19+
Pre-release! Use :command:`pip install --pre zarr` to evaluate this release.
2020

2121
Major changes
2222
~~~~~~~~~~~~~

0 commit comments

Comments
 (0)