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
Johannes Marbach 00af39ecca
Provide MD checklists for the changelog (#1937)
* Output changelog checklists

Fixes: #1682
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2 months ago
..
appendices/newsfragments Document that the spec uses RFC 2119 (#1928) 3 months ago
application_service/newsfragments Document that the spec uses RFC 2119 (#1928) 3 months ago
client_server/newsfragments MSC3939: Account locking (#1934) 2 months ago
identity_service/newsfragments Document that the spec uses RFC 2119 (#1928) 3 months ago
internal/newsfragments Provide MD checklists for the changelog (#1937) 2 months ago
legacy Add a hyphen between third and party when used as an adjective (#1447) 2 years ago
push_gateway/newsfragments Document that the spec uses RFC 2119 (#1928) 3 months ago
room_versions/newsfragments Document that the spec uses RFC 2119 (#1928) 3 months ago
server_server/newsfragments Use "server name" instead of "DNS name" to avoid confusion (#1946) 2 months ago
README.md Release process: changelog generation and docs (#3446) 3 years ago
header.md Provide MD checklists for the changelog (#1937) 2 months ago
pyproject.toml Fix rendered changelog with new version of towncrier (#1598) 1 year ago
template.md.jinja Provide MD checklists for the changelog (#1937) 2 months 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.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

There are a few places you'll have to update:

  • /layouts/shortcodes/changelog/changelog-changes.html to account for the new changelog.
  • /scripts/generate-changelog.sh to render the changelog for releases.
  • Supporting documentation such as the contributing guidelines.