Changelogs #5

New issue

Closed

opened 2025-10-07 23:42:55 -03:00 by dunossauro · 1 comment

dunossauro commented

2025-10-07 23:42:55 -03:00

Member

Before starting code, I strongly recommend starting a changelog.

For that, we can use Towncrier with a Keep a Changelog model.

Towncrier is compatible with MkDocs using mkdocs-towncrier.

Something like:

[tool.towncrier]
directory = "changelogs"
filename = "CHANGELOG.md"
start_string = "<!-- towncrier release notes start -->\n"
underlines = ["", "", ""]
title_format = "## [{version}](https://bolha.dev/vitae/backend-vitae/tree/{version}) - {project_date}"
issue_format = "[#{issue}](https://bolha.dev/vitae/backend-vitae/issues/{issue})"

[[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"

Before starting code, I strongly recommend starting a changelog. For that, we can use [Towncrier](https://towncrier.readthedocs.io/en/stable/index.html) with a [Keep a Changelog](https://keepachangelog.com/) model. Towncrier is compatible with MkDocs using [mkdocs-towncrier](https://github.com/davfsa/mkdocs-towncrier). Something like: ```toml [tool.towncrier] directory = "changelogs" filename = "CHANGELOG.md" start_string = "\n" underlines = ["", "", ""] title_format = "## [{version}](https://bolha.dev/vitae/backend-vitae/tree/{version}) - {project_date}" issue_format = "[#{issue}](https://bolha.dev/vitae/backend-vitae/issues/{issue})" [[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" ```