Support a 'removed endpoints' changelog type

changelogs/README.md

@@ -2,14 +2,14 @@
 
 # Changelogs
 
-[Towncrier](https://github.com/hawkowl/towncrier) is used to manage the changelog and 
+[Towncrier](https://github.com/hawkowl/towncrier) is used to manage the changelog and
 keep it up to date. Because of this, updating a changelog is really easy.
 
 ## How to update a changelog when releasing an API
 
 1. Ensure you're in your Python 3 virtual environment
 2. `cd` your way to the API you're releasing (eg: `cd changelogs/client_server`)
-3. Run `towncrier --version "r0.4.0" --name "client-server" --yes` substituting the 
+3. Run `towncrier --version "r0.4.0" --name "client-server" --yes` substituting the
    variables as approprite. Note that `--name` is required although the value is ignored.
 4. Commit the changes and finish the release process.
 
@@ -26,27 +26,32 @@ For this example, we're going to pretend that the `server_server` API doesn't ex
     directory = "newsfragments"
     issue_format = "`#{issue} <https://github.com/matrix-org/matrix-doc/issues/{issue}>`_"
     title_format = "{version}"
-    
+
     [[tool.towncrier.type]]
         directory = "breaking"
         name = "Breaking Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "deprecation"
         name = "Deprecations"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "new"
         name = "New Endpoints"
         showcontent = true
-    
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"

changelogs/application_service/pyproject.toml

@@ -3,27 +3,32 @@
     directory = "newsfragments"
     issue_format = "`#{issue} <https://github.com/matrix-org/matrix-doc/issues/{issue}>`_"
     title_format = "{version}"
-    
+
     [[tool.towncrier.type]]
         directory = "breaking"
         name = "Breaking Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "deprecation"
         name = "Deprecations"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "new"
         name = "New Endpoints"
         showcontent = true
-    
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"

changelogs/client_server/pyproject.toml

@@ -3,27 +3,32 @@
     directory = "newsfragments"
     issue_format = "`#{issue} <https://github.com/matrix-org/matrix-doc/issues/{issue}>`_"
     title_format = "{version}"
-    
+
     [[tool.towncrier.type]]
         directory = "breaking"
         name = "Breaking Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "deprecation"
         name = "Deprecations"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "new"
         name = "New Endpoints"
         showcontent = true
-    
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"

changelogs/identity_service/pyproject.toml

@@ -19,6 +19,11 @@
         name = "New Endpoints"
         showcontent = true
 
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"

changelogs/push_gateway/pyproject.toml

@@ -3,27 +3,32 @@
     directory = "newsfragments"
     issue_format = "`#{issue} <https://github.com/matrix-org/matrix-doc/issues/{issue}>`_"
     title_format = "{version}"
-    
+
     [[tool.towncrier.type]]
         directory = "breaking"
         name = "Breaking Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "deprecation"
         name = "Deprecations"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "new"
         name = "New Endpoints"
         showcontent = true
-    
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"

changelogs/server_server/pyproject.toml

@@ -3,27 +3,32 @@
     directory = "newsfragments"
     issue_format = "`#{issue} <https://github.com/matrix-org/matrix-doc/issues/{issue}>`_"
     title_format = "{version}"
-    
+
     [[tool.towncrier.type]]
         directory = "breaking"
         name = "Breaking Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "deprecation"
         name = "Deprecations"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "new"
         name = "New Endpoints"
         showcontent = true
-    
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Removed Endpoints"
+        showcontent = true
+
     [[tool.towncrier.type]]
         directory = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
-    
+
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"