The documentation section How to Keep a Changelog in Markdown is very nice, but the required configuration is rather verbose
[tool.towncrier]
directory = "changelog.d"
filename = "CHANGELOG.md"
start_string = "<!-- towncrier release notes start -->\n"
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})"
[[tool.towncrier.type]]
directory = "security"
name = "Security"
showcontent = true
[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true
[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true
[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true
[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true
[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = trueThere are two things towncrier could do to shorten this, presumably, very popular configuration.
- The documentation says
showcontent = true by default when using TOML tables, but this is wrong. If you comment out showcontent = true in the above configuration, you get a missing key error when building the changelog.
- You should only need to specify
directory or name in the above configuration. The other can be reasonably inferred (with an option to override this behavior by specifying both).
Would the maintainers of towncrier be open to receiving a PR with these two changes? They would both be fully backward-compatible.
The documentation section How to Keep a Changelog in Markdown is very nice, but the required configuration is rather verbose
There are two things
towncriercould do to shorten this, presumably, very popular configuration.showcontent = trueby default when using TOML tables, but this is wrong. If you comment outshowcontent = truein the above configuration, you get a missing key error when building the changelog.directoryornamein the above configuration. The other can be reasonably inferred (with an option to override this behavior by specifying both).Would the maintainers of
towncrierbe open to receiving a PR with these two changes? They would both be fully backward-compatible.