Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Not the cleanest release ... pre-commit was not invited ... I have to update the release github action Relese candidate available for testing |
|
FTR, here's a compat tracking issue in my Sphinx extension: sphinx-contrib/sphinxcontrib-towncrier#121. So far, only one test is failing but given that I'm reaching into private APIs in there, it shouldn't be a blocker here, upstream. |
|
I think the interesting bit is this page https://towncrier--718.org.readthedocs.build/en/718/release-notes.html |
NEWS.rst
Outdated
| - When used with an `pyproject.toml` file, when no explicit values are | ||
| defined for [tool.towncrier.name|package] they will now fallback to | ||
| the value of [project.name]. (`#687 <https://github.com/twisted/towncrier/issues/687>`_) | ||
| - More simple configuration for Keep a Changelog style changelogs (`#691 <https://github.com/twisted/towncrier/issues/691>`_) |
There was a problem hiding this comment.
This entry isn't very clear from the PoV of an end-user. Reading it in the change log, I don't understand what the effect is for me.
| - When no sections are present, | ||
| the default Markdown template now renders the category headers as H2. | ||
| In previous versions it was rendered as H3. (`#663 <https://github.com/twisted/towncrier/issues/663>`_) |
There was a problem hiding this comment.
Should this entry be under removals it's a feature / behavior change if you ask me.
There was a problem hiding this comment.
We can have a better name for Deprecations and Removals ... basically.
under Deprecations and Removals we have any "breaking changes"
We can look to update the template and use "Breaking changes"
There was a problem hiding this comment.
@adiroiban yeah, I should probably propose updating the default templates. Over at @aio-libs and in other projects, I ended up having more accurate categories like contrib/packaging/downstream: https://yarl.aio-libs.org/en/latest/changes/#id100 / https://yarl.aio-libs.org/en/latest/contributing/guidelines/#alright-so-how-to-add-a-news-fragment / https://github.com/aio-libs/yarl/blob/b8d06ec9a7d95ac11437afd5e467c2c2bb1704d2/towncrier.toml#L18-L68.
Though, I wouldn't consider this all a part of the release PR. It's probably best to postpone until post-release.
| Misc | ||
| ---- | ||
|
|
||
| - `#667 <https://github.com/twisted/towncrier/issues/667>`_, `#669 <https://github.com/twisted/towncrier/issues/669>`_, `#679 <https://github.com/twisted/towncrier/issues/679>`_, `#680 <https://github.com/twisted/towncrier/issues/680>`_, `#682 <https://github.com/twisted/towncrier/issues/682>`_, `#701 <https://github.com/twisted/towncrier/issues/701>`_, `#702 <https://github.com/twisted/towncrier/issues/702>`_, `#713 <https://github.com/twisted/towncrier/issues/713>`_ |
There was a problem hiding this comment.
Does this have to be a single bullet point?
| - `#667 <https://github.com/twisted/towncrier/issues/667>`_, `#669 <https://github.com/twisted/towncrier/issues/669>`_, `#679 <https://github.com/twisted/towncrier/issues/679>`_, `#680 <https://github.com/twisted/towncrier/issues/680>`_, `#682 <https://github.com/twisted/towncrier/issues/682>`_, `#701 <https://github.com/twisted/towncrier/issues/701>`_, `#702 <https://github.com/twisted/towncrier/issues/702>`_, `#713 <https://github.com/twisted/towncrier/issues/713>`_ | |
| `#667 <https://github.com/twisted/towncrier/issues/667>`_, `#669 <https://github.com/twisted/towncrier/issues/669>`_, `#679 <https://github.com/twisted/towncrier/issues/679>`_, `#680 <https://github.com/twisted/towncrier/issues/680>`_, `#682 <https://github.com/twisted/towncrier/issues/682>`_, `#701 <https://github.com/twisted/towncrier/issues/701>`_, `#702 <https://github.com/twisted/towncrier/issues/702>`_, `#713 <https://github.com/twisted/towncrier/issues/713>`_. |
There was a problem hiding this comment.
This is how it's implemented now in the template and is how we did it in the past
the ".misc" items might not have a description
Now... if you ask me, I would say that we should not list these items at all in the release notes
But this is a discussion for a separate issue/PR
There was a problem hiding this comment.
Agreed. This is separate. Though, I feel like misc items should be rendered with content, just like the others. If something isn't necessary in the change log, it should just not have a note to begin with.
There was a problem hiding this comment.
I like the .misc notes. ... but I agree they should not be rendered.
They are an explicit confirmation that the changes are not public.
It makes it easier to raise an errror in the case you accidentally forget to update the release notes for a public change.
We can look into this as part of updating the template that we user towncrier
We don't have to change the default template , towncrier can have a custom template ... but I think that it makese sense for towncrier itself to use the default template
I am happy to update the default template... but in a separate issue
UPD: it looks like there's no need for any compat code in there, just a test adjustment. I've added 25.8.0rc2 to the CI matrix and it's green: sphinx-contrib/sphinxcontrib-towncrier@ab800bc / https://github.com/sphinx-contrib/sphinxcontrib-towncrier/actions/runs/17045398297. |
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <sviat@redhat.com>
|
Thanks for the review. Much appreciated. I have applied your suggestions. The result is at https://towncrier--718.org.readthedocs.build/en/718/release-notes.html I guess that we are ready for a new release I am happy to change the template of our release notes... but this needs a separate issue. I am happy to rename |
Yeah, I have workflows that use However, I feel like it's so much easier to just switch over to Markdown with MyST-Parser. This is something to consider after releasing, though. |
|
@adiroiban I think this is ready for a final release, FWIW. |
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <sviat@redhat.com>
|
Many thanks for the review and great feedback. Much appreciated. I have trigger the release at https://github.com/twisted/towncrier/actions/runs/17343314258 PyPI at https://pypi.org/project/Twisted/25.5.0/ As mentions, I am happy to change the default template...but this needs to be discussed in a separate issue. |
2 participants
Description
Fixes #717
THis is the PR for a new release
Release process documented at https://towncrier.readthedocs.io/en/stable/release.html