Fix rendered changelog with new version of towncrier #1598
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Instead of generating the changelog for each section Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
zecakeh
commented
Jul 12, 2023
| @@ -6,4 +6,4 @@ jsonschema >= 4.0.0 | |||
|
|
|||
| PyYAML >= 3.12 | |||
| requests >= 2.18.4 | |||
| towncrier == 21.9.0rc1 | |||
| towncrier == 23.6.0 | |||
There was a problem hiding this comment.
Note that towncrier's version is pinned here but not in CI, should that be the case?
There was a problem hiding this comment.
Note that towncrier's version is pinned here but not in CI, should that be the case?
Yes, it should probably be pinned in CI too. Or rather, to save us inevitably forgetting to update one or the other, CI should pip install -r requirements.txt rather than installing a random version of towncrier.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
The method to resolve references changed in 4.18 and a regression was introduced in 4.18.1 Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The version of towncrier is not pinned in CI so lately the rendering of the changelog is broken in the unstable version (note the changelog categories that are now numbered titles):
This is due to twisted/towncrier#483 that is included in towncrier 23.6.0.
The first commit fixes that by replacing the default template by a custom one. It also allows to put formatting in the template only rather than in the config file.
The second commit allows to simplify the
generate-changelog.shscript by using the built-in sections feature of towncrier, instead of generating the changelog for each section separately.This is the result, which should be the same as before:
We could almost get rid of the
header.mdfile except we cannot format the release date.Preview: https://pr1598--matrix-spec-previews.netlify.app