Skip to content

Add a release checklist issue template #3210

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 8 commits into from
Jul 7, 2025

Conversation

maxrjones
Copy link
Member

This is an example of the release checklist template proposed in #3209, based on https://github.com/GenericMappingTools/pygmt/blob/main/.github/ISSUE_TEMPLATE/4-release_checklist.md.

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/user-guide/*.rst
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Jul 6, 2025
@d-v-b
Copy link
Contributor

d-v-b commented Jul 7, 2025

@zarr-developers/python-core-devs since we would like to release 3.1.0 soon, it would be great to get a lot of eyes on this

@dstansby
Copy link
Contributor

dstansby commented Jul 7, 2025

Sorry, I don't have time to review in detail. I'm 👍 to moving the checklist here, but info at https://zarr.readthedocs.io/en/stable/developers/contributing.html#release-procedure should be removed at the same time to make sure we're not duplicating info across different places.

@maxrjones
Copy link
Member Author

Sorry, I don't have time to review in detail. I'm 👍 to moving the checklist here, but info at zarr.readthedocs.io/en/stable/developers/contributing.html#release-procedure should be removed at the same time to make sure we're not duplicating info across different places.

Thanks for the general review! https://github.com/zarr-developers/zarr-python/pull/3210/files#diff-4c43ecea097324201785238a3e9969e3490fc89d8f8a5a0363439c6bc893e354 includes a removal of the duplication from the contributing guide.

it would be great to get a lot of eyes on this

FWIW this change doesn't touch the codebase and can be easily reverted or modified. My recommendation would be to not spend too much time trying to make this perfect in advance, try it out for 3.1.0 release, and edit the template in a follow-up based on the smoothness of the release process.

To help the review, I temporarily enabled issues on my fork so you can see what it looks like in practice:

@d-v-b
Copy link
Contributor

d-v-b commented Jul 7, 2025

FWIW this change doesn't touch the codebase and can be easily reverted or modified. My recommendation would be to not spend too much time trying to make this perfect in advance, try it out for 3.1.0 release, and edit the template in a follow-up based on the smoothness of the release process.

💯 , I just want to ensure that this effort gets high visibility among the other devs

- [ ] All tests pass in the ["GPU Tests" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/gpu_test.yml)
- [ ] All tests pass in the ["Hypothesis" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/hypothesis.yaml)
- [ ] All tests pass in [Xarray's upstream test](https://github.com/pydata/xarray/actions/workflows/upstream-dev-ci.yaml)
- [ ] Click on the most recent workflow and check that the `upstream-dev` job has run and passed. `upstream-dev` is not run on all all workflow runs.
Copy link
Member

Choose a reason for hiding this comment

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

Would a failing upstream dev test block a release if it was not related to Zarr?

Copy link
Member Author

@maxrjones maxrjones Jul 7, 2025

Choose a reason for hiding this comment

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

e9157f3 (#3210) updates the downstream component of the checklist to follow the structure that's worked pretty well for GMT. The developers of downstream libraries are pinged as part of the release checklist issue. Zarr-Python devs can decide whether to wait for all those downstream checks to be completed and whether any failures should be blocking.

Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

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

I love this. I do think we should be careful not to put too many hard blockers on releasing (e.g. tests in other packages). So long as we can use judgement on those, I'm all for this checklist.

Copy link
Contributor

@d-v-b d-v-b left a comment

Choose a reason for hiding this comment

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

this looks great, let me know if you need more time with or if we can merge as-is

@maxrjones
Copy link
Member Author

this looks great, let me know if you need more time with or if we can merge as-is

not sure if this was meant for me, but I don't have any planned changes for this PR

@d-v-b d-v-b enabled auto-merge (squash) July 7, 2025 20:55
@d-v-b d-v-b merged commit 111d765 into zarr-developers:main Jul 7, 2025
28 checks passed
@maxrjones maxrjones deleted the release-checklist branch July 7, 2025 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants