When used with a text that includes multiple paragraphs, the partial created invalid HTML by nesting `<p>` elements. It also changed the rendering by making "Changed in vX.XX:" a separate paragraph, when it is inline with a single paragraph. To change that we do as with "Required" and add "Changed in vX.XX:" to the text before it is rendered, making it inline with the first paragraph. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> |
||
---|---|---|
.. | ||
appendices/newsfragments | ||
application_service/newsfragments | ||
client_server/newsfragments | ||
identity_service/newsfragments | ||
internal/newsfragments | ||
legacy | ||
push_gateway/newsfragments | ||
room_versions/newsfragments | ||
server_server/newsfragments | ||
header.md | ||
pyproject.toml | ||
README.md | ||
template.md.jinja |
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.