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.
![]() |
5 years ago | |
---|---|---|
.. | ||
application_service | 5 years ago | |
client_server | 5 years ago | |
identity_service | 5 years ago | |
push_gateway | 5 years ago | |
server_server | 5 years ago | |
README.md | 6 years ago | |
application_service.rst | 5 years ago | |
client_server.rst | 5 years ago | |
identity_service.rst | 5 years ago | |
push_gateway.rst | 5 years ago | |
server_server.rst | 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 = "feature" name = "Backwards Compatible Changes" showcontent = true [[tool.towncrier.type]] directory = "clarification" name = "Spec Clarifications" showcontent = true
- Create a
.gitignore
inchangelogs/server_server/newsfragments
with the contents!.gitignore