72735cfff8
1. Use [towncrier][1] to generate release notes/CHANGELOG instead of auto-generating it from git commit messages. 2. Move release scripts into a Justfile. 3. Only regenerate the top-level README file when making a release, don't force it to be up to date in between releases. Point 3 helps prevent documentation for unreleased changes from being shown to users on GitHub, which may otherwise be confusing. [1]: https://towncrier.readthedocs.io/en/stable/index.html#
35 lines
759 B
TOML
35 lines
759 B
TOML
[tool.towncrier]
|
|
name = "obsidian-export"
|
|
directory = "changelog.d"
|
|
template = "changelog.d/template.md"
|
|
filename = "CHANGELOG.md"
|
|
start_string = "<!-- towncrier release notes start -->\n"
|
|
underlines = ["", "", ""]
|
|
title_format = ""
|
|
issue_format = "[#{issue}](https://github.com/zoni/obsidian-export/issues/{issue})"
|
|
|
|
[[tool.towncrier.type]]
|
|
directory = "new"
|
|
name = "New Features"
|
|
showcontent = true
|
|
|
|
[[tool.towncrier.type]]
|
|
directory = "change"
|
|
name = "Changes"
|
|
showcontent = true
|
|
|
|
[[tool.towncrier.type]]
|
|
directory = "fix"
|
|
name = "Fixes"
|
|
showcontent = true
|
|
|
|
[[tool.towncrier.type]]
|
|
directory = "breaking"
|
|
name = "Backwards-incompatible Changes"
|
|
showcontent = true
|
|
|
|
[[tool.towncrier.type]]
|
|
directory = "deprecation"
|
|
name = "Deprecations"
|
|
showcontent = true
|