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.
matrix-spec/changelogs
Travis Ralston adb721bc0b Fix unrelated changelog entry's RST representation 6 years ago
..
application_service Prepare the appservice spec for an r0 release 6 years ago
client_server Fix unrelated changelog entry's RST representation 6 years ago
identity_service Add changelogs 6 years ago
push_gateway r0.1.0 release of the Push Gateway specification 6 years ago
server_server Add clarification changelog entry. 6 years ago
README.md Don't let the newsfragments wink out of existence 6 years ago
application_service.rst Appservice r0.1.0 changelog 6 years ago
client_server.rst Client-server r0.4.0 changelog 6 years ago
identity_service.rst Changelog for r0.1.0 IS spec 6 years ago
push_gateway.rst r0.1.0 release of the Push Gateway specification 6 years ago
server_server.rst Prep for r0.1.1 of s2s 6 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

  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 variables as approprite. Note that --name is required although the value is ignored.
  4. 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.

  1. Create the file changelogs/server_server.rst
  2. Create the folder changelogs/server_server
  3. 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 = "feature"
         name = "Backwards Compatible Changes"
         showcontent = true
    
     [[tool.towncrier.type]]
         directory = "clarification"
         name = "Spec Clarifications"
         showcontent = true
    
  4. Create a .gitignore in changelogs/server_server/newsfragments with the contents !.gitignore