Skip to content

Bootstrap release notes post v3 #2680

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
Jan 11, 2025
Merged

Bootstrap release notes post v3 #2680

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
21 changes: 15 additions & 6 deletions docs/developers/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,10 +329,16 @@ Release procedure
Most of the release process is now handled by GitHub workflow which should
automatically push a release to PyPI if a tag is pushed.

Before releasing, make sure that all pull requests which will be
included in the release have been properly documented in
`docs/release.rst`.

Pre-release
"""""""""""
1. Make sure that all pull requests which will be
included in the release have been properly documented in
:file:`docs/release-notes.rst`.
2. Rename the "Unreleased" section heading in :file:`docs/release-notes.rst`
Copy link
Member

Choose a reason for hiding this comment

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

That seems a bit annoying because it requires another commit before the release or am I understanding it wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that's right. I guess with the current system, unless we decide on the version numbering ahead of time then this is unavoidable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On other projects I've used https://towncrier.readthedocs.io/en/stable/ with success, and it was suggested a while ago here too: #829.

You still have to generate the changelog before release, but it makes having multiple branches easier (e.g., if we have a 3.0.x branch for bugfixes and main for 3.x.0 releases), and would mean the extra commit after release (your comment below) wouldn't be needed.

I'd be up for trying to set towncrier up, either instead of or after this PR?

to the version you are about to release.

Releasing
"""""""""
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
Expand All @@ -355,5 +361,8 @@ https://readthedocs.io. Full releases will be available under
pre-releases will be available under
`/latest <https://zarr.readthedocs.io/en/latest>`_.

Also review and merge the https://github.com/conda-forge/zarr-feedstock
pull request that will be automatically generated.
Post-release
""""""""""""

- Review and merge the pull request on the `conda-forge feedstock <https://github.com/conda-forge/zarr-feedstock>`_ that will be automatically generated.
- Create a new "Unreleased" section in the release notes
Copy link
Member

Choose a reason for hiding this comment

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

And another commit here?

Loading