From 20bd445602c43363b0a90e57f3f66143b518d254 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 4 Jan 2022 20:23:02 -0700 Subject: [PATCH] Add a changelog for the appendices (#3609) As a document which is versioned, we should have a changelog for it. It might be empty most of the time but oh well. --- changelogs/appendices/newsfragments/.gitignore | 1 + changelogs/appendices/newsfragments/3171.feature | 1 + content/appendices.md | 2 ++ layouts/shortcodes/changelog/changelog-changes.html | 1 + scripts/generate-changelog.sh | 1 + 5 files changed, 6 insertions(+) create mode 100644 changelogs/appendices/newsfragments/.gitignore create mode 100644 changelogs/appendices/newsfragments/3171.feature diff --git a/changelogs/appendices/newsfragments/.gitignore b/changelogs/appendices/newsfragments/.gitignore new file mode 100644 index 00000000..b722e9e1 --- /dev/null +++ b/changelogs/appendices/newsfragments/.gitignore @@ -0,0 +1 @@ +!.gitignore \ No newline at end of file diff --git a/changelogs/appendices/newsfragments/3171.feature b/changelogs/appendices/newsfragments/3171.feature new file mode 100644 index 00000000..1f307fa5 --- /dev/null +++ b/changelogs/appendices/newsfragments/3171.feature @@ -0,0 +1 @@ +Describe "Common Namespaced Identifier Grammar" as per [MSC2758](https://github.com/matrix-org/matrix-doc/pull/2758). \ No newline at end of file diff --git a/content/appendices.md b/content/appendices.md index 493fc974..2b6de33e 100644 --- a/content/appendices.md +++ b/content/appendices.md @@ -389,6 +389,8 @@ information. ### Common Namespaced Identifier Grammar +{{% added-in v="1.2" %}} + The specification defines some identifiers to use the *Common Namespaced Identifier Grammar*. This is a common grammar intended for non-user-visible identifiers, with a defined mechanism for implementations to create new diff --git a/layouts/shortcodes/changelog/changelog-changes.html b/layouts/shortcodes/changelog/changelog-changes.html index 4995a6bd..9b0e71a9 100644 --- a/layouts/shortcodes/changelog/changelog-changes.html +++ b/layouts/shortcodes/changelog/changelog-changes.html @@ -37,6 +37,7 @@ {{ partial "render-api-changes" (dict "title" "Identity Service API" "id" "identity-service-api" "path" (path.Join $path "identity_service")) }} {{ partial "render-api-changes" (dict "title" "Push Gateway API" "id" "push-gateway-api" "path" (path.Join $path "push_gateway")) }} {{ partial "render-api-changes" (dict "title" "Room Versions" "id" "room-versions" "path" (path.Join $path "room_versions")) }} +{{ partial "render-api-changes" (dict "title" "Appendices" "id" "appendices" "path" (path.Join $path "appendices")) }} {{ define "partials/render-api-changes" }}

{{ .title }}

diff --git a/scripts/generate-changelog.sh b/scripts/generate-changelog.sh index 4209f4a3..1d82e5db 100644 --- a/scripts/generate-changelog.sh +++ b/scripts/generate-changelog.sh @@ -12,6 +12,7 @@ cd changelogs rm -f rendered.* # Reversed order so that room versions ends up on the bottom +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