-
Notifications
You must be signed in to change notification settings - Fork 129
Description
Right now, the markup for issue and titles is generated by towncrier
outside of the template
So for, .MD we have things like this.
underlines = ["", "", ""]
title_format = "## [{version}](https://github.com/twisted/my-project/tree/{version}) - {project_date}"
issue_format = "[#{issue}](https://github.com/twisted/my-project/issues/{issue})"
I think that it would help to simplify this config and allow to fully control the format from the Jinja2 template.
Each issue and title will just recevie the raw data and the Jinja template can decide how to transform it.
We could have a default template that add links to version and issues
The configuration will only need to define the links
issue_url = "https://github.com/twisted/my-project/issues/{issue}"
version_url = "https://github.com/twisted/my-project/tree/{version}"
If I understand you correctly, I would add a new template file
keep_a_changelog.md
and then update the documentation to promote the usage as[tool.towncrier] directory = "changelog.d" filename = "CHANGELOG.md" template = "towncrier:keep_a_changelog.md" issue_url = "https://github.com/twisted/my-project/issues/{issue}" version_url = "https://github.com/twisted/my-project/tree/{version}" [[tool.towncrier.type]] name = "Security" [[tool.towncrier.type]] name = "Removed" [[tool.towncrier.type]] name = "Deprecated" [[tool.towncrier.type]] name = "Added" [[tool.towncrier.type]] name = "Changed" [[tool.towncrier.type]] name = "Fixed"Is that what you had in mind? Is it still necessary to specify the custom types if we request the
keep_a_changelog.md
template?
Originally posted by @matteosantama in #691