MAINT: ensure towncrier can be run >1x, and is included in spin docs
#25933
Conversation
|
CI doc build looks happy too: https://output.circle-artifacts.com/output/job/9f42cbe9-a4a5-43bc-a690-eef35559e762/artifacts/0/doc/build/html/release/2.0.0-notes.html That will fix the now-missing notes at https://numpy.org/devdocs/release/2.0.0-notes.html. |
|
I am not clear on how |
|
I think this is as good as it gets while using towncrier. There is some cruft left at the bottom of the release notes but after branching the notes are tweaked anyway. |
|
Note that the release notes also require |
This allows accumulating snippets into the main release notes file and committing the result during a release cycle. It will also make Sphinx formatting errors, cross-link issues, etc. visible when docs get built locally. This will allow fixing them as we go, rather than leaving it broken in devdocs and then having to fix it in one go once `towncrier` is run once right before or after creating a release branch. xref numpygh-25921 and numpygh-25827 for recent issues with this. [skip azp] [skip actions] [skip cirrus]
3018fb1 to
f90d3c5
Compare
Fixed that in I also updated the release walkthrough document. |
There was a problem hiding this comment.
Thanks, nice to just always build it and it doesn't seem to make the release process harder.
I still don't like the idea of committing partial changes except maybe very late in the release cycle, but it doesn't matter.
In either case @charris is the one who dealt with this the most in the past and currently, so I think he should sign off/merge.
|
|
||
| New Features | ||
| ============ | ||
| *We'll choose highlights for this release near the end of the release cycle.* |
There was a problem hiding this comment.
We actually have a highlights section also in the release notes fragments which I think makes sense to not forget a highlight. OTOH, I am not sure we ever actually used it so this is fine also.
There was a problem hiding this comment.
Yeah I think it's easier to determine at the end. It's a bit weird to add a note to one's own PR that the thing you're working on right now will be a highlight of the next release:)
There was a problem hiding this comment.
Sure, you certainly have to audit it at the end.
|
Well, let's give it a shot. Thanks Ralf. |
This allows accumulating snippets into the main release notes file and committing the result during a release cycle. It will also make Sphinx formatting errors, cross-link issues, etc. visible when docs get built locally. This will allow fixing them as we go, rather than leaving it broken in devdocs and then having to fix it in one go once
towncrieris run once right before or after creating a release branch.xref gh-25921 and gh-25827 for recent issues with this.