Skip to content

Commit 16d5ea1

Browse files
committed
Update release instructions for pre-releases
1 parent 716e4ac commit 16d5ea1

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/contributing.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -344,14 +344,22 @@ included in the release have been properly documented in
344344
To make a new release, go to
345345
https://github.com/zarr-developers/zarr-python/releases and
346346
click "Draft a new release". Choose a version number prefixed
347-
with a `v` (e.g. `v0.0.0`) and set the description to:
347+
with a `v` (e.g. `v0.0.0`). For pre-releases, include the
348+
appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
348349

349-
```
350-
See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0
351-
```
350+
351+
Set the description of the release to::
352+
353+
See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0
352354

353355
replacing the correct version numbers. For pre-release versions,
354356
the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
355357

356-
Be sure to review and merge the https://github.com/conda-forge/zarr-feedstock
358+
After creating the release, the documentation will be built on
359+
https://readthedocs.io. Full releases will be available under
360+
`/stable <https://zarr.readthedocs.io/en/stable>`_ while
361+
pre-releases will be available under
362+
`/latest <https://zarr.readthedocs.io/en/latest>`_.
363+
364+
Also review and merge the https://github.com/conda-forge/zarr-feedstock
357365
pull request that will be automatically generated.

0 commit comments

Comments
 (0)