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.

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

Conversation

joshmoore
Copy link
Member

@joshmoore joshmoore commented Sep 2, 2022

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.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

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.
Comment on lines +344 to +347
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:
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

@jakirkham
Copy link
Member

Thanks Josh! 🙏

Should we update the docs in Numcodecs?

@joshmoore
Copy link
Member Author

Let's figure out if we want to follow this strategy or your #1118 suggestion. I'll merge this and try it out for this upcoming release.

@joshmoore joshmoore merged commit ea7bb11 into zarr-developers:main Sep 8, 2022
@joshmoore joshmoore deleted the more-releases branch September 8, 2022 06:48
@joshmoore joshmoore mentioned this pull request Sep 8, 2022
6 tasks
@joshmoore
Copy link
Member Author

Instructions updated in #1133 after testing with 2.13.0a2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants