Bootstrap release notes post v3#2680
Conversation
| 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` |
There was a problem hiding this comment.
That seems a bit annoying because it requires another commit before the release or am I understanding it wrong?
There was a problem hiding this comment.
Yeah, that's right. I guess with the current system, unless we decide on the version numbering ahead of time then this is unavoidable?
There was a problem hiding this comment.
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?
| """""""""""" | ||
|
|
||
| - 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 |
|
Fwiw, I started release notes in #2679 |
dstansby
force-pushed
the
post-v3-release-notes
branch
from
ff5fc09 to
95187ff
Compare
|
Thanks! I think worth merging this as an honest documentation of what the current process is, then if someone wants to work on #829 that can be a bigger task for another PR. |
2 participants
This adds a new section for new release notes, and also updates the release guide to explain how to handle the release notes. The sections I chose for the release notes are very much up for change/suggestion.