Skip to content

Simplify release docs #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2022
Merged

Simplify release docs #1119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Comment on lines +344 to +347
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted in issue ( #1118 ), we could alternatively use a GitHub action to automate this step of adding and linking the release notes, in which case we would only need to create a tag on GitHub to kick off the release process


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.
2 changes: 1 addition & 1 deletion docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~
Expand Down