You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Hubert Chathi b231220bbd Merge pull request #3337 from uhoreg/room_create_canonical_alias room creation: create canonical alias event if alias specified		3 years ago
..
application_service	Add changelogs for 2888	4 years ago
client_server	Merge pull request #3337 from uhoreg/room_create_canonical_alias	3 years ago
identity_service	Update 3167.clarification	3 years ago
push_gateway	Add a link to the push module in the push gateway spec	4 years ago
server_server	`/_matrix/federation/v1/user/devices/{userId}`: Rename `self_signing_keys` to `self_signing_key` (#3312 )	3 years ago
README.md	Support a 'removed endpoints' changelog type	5 years ago
application_service.rst	Appservices r0.1.2 changelog	5 years ago
client_server.rst	Client-Server r0.6.1	5 years ago
identity_service.rst	Identity Service r0.3.0 release	5 years ago
push_gateway.rst	Push r0.1.1 changelog	5 years ago
server_server.rst	Fix r0.1.4 changelog reference	5 years ago

README.md

Changelogs

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

Ensure you're in your Python 3 virtual environment
cd your way to the API you're releasing (eg: cd changelogs/client_server)
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.
Commit the changes and finish the release process.

How to prepare a changelog for a new API

For this example, we're going to pretend that the server_server API doesn't exist.

Create the file changelogs/server_server.rst
Create the folder changelogs/server_server

In the new folder, create a pyproject.toml file with these contents:

[tool.towncrier]
 filename = "../server_server.rst"
 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"
     showcontent = true

Create a .gitignore in changelogs/server_server/newsfragments with the contents !.gitignore