-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
DOC: run towncrier to consolidate the 2.0.0 release notes to data #25827
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
Conversation
[skip cirrus] [skip actions] [skip azp]
Thanks Ralf. |
I think this lost the ones that were inlcuded by the previous generation in #24510? There some smaller fixups on that, but not sure they are relevant, maybe it is easier to just pull in all those fragments again. |
Oh great, a tool that silently deletes content. And doesn't even have an option for merging as far as I can tell from https://towncrier.readthedocs.io/en/stable/cli.html#towncrier-build. I only checked one of the first deleted lines in the diff and saw it was moved, so I thought it was a diff display thing and didn't check the whole thing. I'll fix this up manually, but it looks to me like it makes the tool pretty much useless then. |
I think you can get a bit of a work-around by adding a line to the generated file to tell towncrier not to remove the current content. There will still be two heading lines, but they can be deleted in the inevitable cleanup. |
Just doing a merge or copying things manually is probably just as well. The point is, towncrier is meant to be run exactly once. |
Hiccup with towncrier in numpygh-25827, this puts everything back. No actual edits beyond fixing a typo and whitespace at end of lines. [skip actions] [skip cirrus] [skip azp]
gh-25832 should restore the missing content.
Ah good find, that seems needed. I'll see about adding that in the next PR.
Let's fix that; this isn't a reasonable restriction and not having a local build seems bad (we'd never accept that for code, so I don't think we should for docs either). I'll see if it's easy to do. |
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]
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]
The first commit is purely running
towncrier
, no manual changes. The second commit fixes all doc build warnings I see locally.Actually editing the 2.0.0 release notes will be a follow-up PR.