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
Fixed towncrier template rendering #9117
Conversation
Moved into the 0.58RC milestone as it fixes #9102 which is in it. |
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.
Thanks for the patch. I noticed a few things that need changing:
- heading level is not aligning with previous CHANGE_LOG entries
- the issue link not going to numba repo
- the section ordering can be improved
|
||
{% endif %} | ||
{% if sections[section] %} | ||
{% for category, val in definitions.items() if category in sections[section] %} |
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.
We should change the ordering of the sections. Currently, the CUDA session is going before the new_features. I found this the ordering is driven by the sections ordering in towncrier.toml. I suggest the following changes to it:
[[tool.towncrier.type]]
directory = "highlight"
name = "Highlights"
showcontent = true
[[tool.towncrier.type]]
directory = "new_feature"
name = "New Features"
showcontent = true
[[tool.towncrier.type]]
directory = "improvement"
name = "Improvements"
showcontent = true
[[tool.towncrier.type]]
directory = "np_support"
name = "NumPy Support"
showcontent = true
[[tool.towncrier.type]]
directory = "cuda"
name = "CUDA API Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "performance"
name = "Performance Improvements and Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "bug_fix"
name = "Bug Fixes"
showcontent = true
[[tool.towncrier.type]]
directory = "change"
name = "Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "deprecation"
name = "Deprecations"
showcontent = true
[[tool.towncrier.type]]
directory = "expired"
name = "Expired Deprecations"
showcontent = true
[[tool.towncrier.type]]
directory = "compatibility"
name = "Compatibility Notes"
showcontent = true
[[tool.towncrier.type]]
directory = "doc"
name = "Documentation Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "infrastructure"
name = "Infrastructure Related Changes"
showcontent = true
docs/upcoming_changes/template.rst
Outdated
{{ "=" * title|length }} | ||
{{ title }} | ||
{{ "=" * title|length }} | ||
|
||
{% for section, _ in sections.items() %} | ||
{% set underline = underlines[0] %}{% if section %}{{ section }} | ||
{{ underline * section|length }}{% set underline = underlines[1] %} |
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.
Co-authored-by: Siu Kwan Lam <1929845+sklam@users.noreply.github.com>
51b4aa8
to
e010b4c
Compare
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.
for a search and replace mistake
38cfb20
to
60b3799
Compare
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.
fixup missing =
Co-authored-by: esc <esc@users.noreply.github.com>
Testing via #9135 yields: |
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.
I have verified via #9135 that the new headings look good and the towncrier build --draft
output can be used to partially auto-generate the new Numba change log.
Resolves #9102,
As per the issue,
Adds a template for towncrier's auto-release notes generation and fixes towncrier build rendering issues.