-
-
Notifications
You must be signed in to change notification settings - Fork 91
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
Fix rendered changelog with new version of towncrier #1598
Conversation
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>
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that towncrier's version is pinned here but not in CI, should that be the case?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fantastic, thank you!
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.sh
script 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:
![image](https://private-user-images.githubusercontent.com/76261501/252993928-36cefeed-03fb-4991-988c-558aaed6d8b0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA5NjMxOTIsIm5iZiI6MTcyMDk2Mjg5MiwicGF0aCI6Ii83NjI2MTUwMS8yNTI5OTM5MjgtMzZjZWZlZWQtMDNmYi00OTkxLTk4OGMtNTU4YWFlZDZkOGIwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzE0VDEzMTQ1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWQ5ZDE1N2UwOGY3ZWM2MjUwN2VlMGY4MWI0M2UxYTQxNDY2YmRhZWZmZDNkYTQzYTViNWYzMjk3ZmJhYjM1ZWUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.sFjeJ7NF8YDoLrpfPatrn_X7Tvj4bLhEktT4NQ4Gue8)
We could almost get rid of the
header.md
file except we cannot format the release date.Preview: https://pr1598--matrix-spec-previews.netlify.app