mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-26 04:54:10 +01:00
Fix rendered changelog with new version of towncrier
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
3ae6bb47d8
commit
34891e8cd8
|
|
@ -1,39 +1,34 @@
|
||||||
[tool.towncrier]
|
[tool.towncrier]
|
||||||
version = "unused"
|
version = "unused"
|
||||||
filename = "../rendered.md"
|
filename = "../rendered.md"
|
||||||
issue_format = "[#{issue}](https://github.com/matrix-org/matrix-spec/issues/{issue})"
|
template = "template.md.jinja"
|
||||||
title_format = "### {name}" # Matches rendered spec, even if awkward
|
|
||||||
underlines = " " # 3 spaces intentionally to hide RST headings
|
|
||||||
|
|
||||||
# Note: The names below have the <strong> tag built-in so the rendered spec *and* the generated
|
|
||||||
# changelog can benefit from sane headings.
|
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "breaking"
|
directory = "breaking"
|
||||||
name = "<strong>Breaking Changes</strong>"
|
name = "Breaking Changes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "deprecation"
|
directory = "deprecation"
|
||||||
name = "<strong>Deprecations</strong>"
|
name = "Deprecations"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "new"
|
directory = "new"
|
||||||
name = "<strong>New Endpoints</strong>"
|
name = "New Endpoints"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "removal"
|
directory = "removal"
|
||||||
name = "<strong>Removed Endpoints</strong>"
|
name = "Removed Endpoints"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "feature"
|
directory = "feature"
|
||||||
name = "<strong>Backwards Compatible Changes</strong>"
|
name = "Backwards Compatible Changes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "clarification"
|
directory = "clarification"
|
||||||
name = "<strong>Spec Clarifications</strong>"
|
name = "Spec Clarifications"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
|
||||||
27
changelogs/template.md.jinja
Normal file
27
changelogs/template.md.jinja
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
{% if versiondata.name %}
|
||||||
|
### {{ versiondata.name }}
|
||||||
|
{% endif %}
|
||||||
|
{% for section_name, section in sections.items() %}
|
||||||
|
{% if section_name %}
|
||||||
|
|
||||||
|
### {{section_name}}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if section %}
|
||||||
|
{% for category, val in definitions.items() if category in section %}
|
||||||
|
**{{ definitions[category]['name'] }}**
|
||||||
|
|
||||||
|
{% for content, issues in section[category].items() %}
|
||||||
|
- {{ content }} (
|
||||||
|
{%- for issue in issues %}
|
||||||
|
[{{issue}}](https://github.com/matrix-org/matrix-spec/issues/{{issue|trim('#')}}){% if not loop.last %}, {% endif %}
|
||||||
|
{%- endfor %}
|
||||||
|
)
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
{% endfor %}
|
||||||
|
{% else %}
|
||||||
|
No significant changes.
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
|
@ -6,4 +6,4 @@ jsonschema >= 4.0.0
|
||||||
|
|
||||||
PyYAML >= 3.12
|
PyYAML >= 3.12
|
||||||
requests >= 2.18.4
|
requests >= 2.18.4
|
||||||
towncrier == 21.9.0rc1
|
towncrier == 23.6.0
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue