Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix rendered changelog with new version of towncrier #1598

Merged
merged 4 commits into from
Jul 18, 2023
Merged

Fix rendered changelog with new version of towncrier #1598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34891e8
Fix rendered changelog with new version of towncrier
zecakeh Jul 12, 2023
8e76764
Use sections config for changelogs
zecakeh Jul 12, 2023
9edfeca
Add changelog
zecakeh Jul 12, 2023
a909dc5
Pin version of jsonschema
zecakeh Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1598.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix rendered changelog with new version of towncrier.
53 changes: 40 additions & 13 deletions changelogs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,66 @@
[tool.towncrier]
version = "unused"
filename = "../rendered.md"
issue_format = "[#{issue}](https://github.com/matrix-org/matrix-spec/issues/{issue})"
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.
filename = "rendered.md"
template = "template.md.jinja"

[[tool.towncrier.type]]
directory = "breaking"
name = "<strong>Breaking Changes</strong>"
name = "Breaking Changes"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecation"
name = "<strong>Deprecations</strong>"
name = "Deprecations"
showcontent = true

[[tool.towncrier.type]]
directory = "new"
name = "<strong>New Endpoints</strong>"
name = "New Endpoints"
showcontent = true

[[tool.towncrier.type]]
directory = "removal"
name = "<strong>Removed Endpoints</strong>"
name = "Removed Endpoints"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "<strong>Backwards Compatible Changes</strong>"
name = "Backwards Compatible Changes"
showcontent = true

[[tool.towncrier.type]]
directory = "clarification"
name = "<strong>Spec Clarifications</strong>"
name = "Spec Clarifications"
showcontent = true

[[tool.towncrier.section]]
name = "Client-Server API"
path = "client_server"

[[tool.towncrier.section]]
name = "Server-Server API"
path = "server_server"

[[tool.towncrier.section]]
name = "Application Service API"
path = "application_service"

[[tool.towncrier.section]]
name = "Identity Service API"
path = "identity_service"

[[tool.towncrier.section]]
name = "Push Gateway API"
path = "push_gateway"

[[tool.towncrier.section]]
name = "Room Versions"
path = "room_versions"

[[tool.towncrier.section]]
name = "Appendices"
path = "appendices"

[[tool.towncrier.section]]
name = "Internal Changes/Tooling"
path = "internal"
24 changes: 24 additions & 0 deletions changelogs/template.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{% 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 %}
11 changes: 2 additions & 9 deletions scripts/generate-changelog.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,8 @@ cd `dirname $0`/../changelogs
# Pre-cleanup just in case it wasn't done on the last run
rm -f rendered.md

# Reversed order so that room versions ends up on the bottom
towncrier --name "Internal Changes/Tooling" --dir "./internal" --config "./pyproject.toml" --yes
towncrier --name "Appendices" --dir "./appendices" --config "./pyproject.toml" --yes
towncrier --name "Room Versions" --dir "./room_versions" --config "./pyproject.toml" --yes
towncrier --name "Push Gateway API" --dir "./push_gateway" --config "./pyproject.toml" --yes
towncrier --name "Identity Service API" --dir "./identity_service" --config "./pyproject.toml" --yes
towncrier --name "Application Service API" --dir "./application_service" --config "./pyproject.toml" --yes
towncrier --name "Server-Server API" --dir "./server_server" --config "./pyproject.toml" --yes
towncrier --name "Client-Server API" --dir "./client_server" --config "./pyproject.toml" --yes
# Generate changelog
towncrier --yes

{
# Prepare the header
Expand Down
4 changes: 2 additions & 2 deletions scripts/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# current at the time of writing

# we need at least version 4.0.0 for support of JSON Schema Draft 2020-12.
jsonschema >= 4.0.0
jsonschema == 4.17.3

PyYAML >= 3.12
requests >= 2.18.4
towncrier == 21.9.0rc1
towncrier == 23.6.0
Copy link
Contributor Author

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?

Copy link
Member

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.