mirror of
https://github.com/long2ice/fastapi-cache.git
synced 2026-03-24 20:47:54 +00:00
📣 Start managing the changelog with towncrier
This PR includes a workflow that validates that future PRs include a changelog entry (unless the `skip-changelog` label is present on the PR, or the PR is a dependabot PR). Use 'poetry run towncrier create` to create entries for the changelog.
This commit is contained in:
@@ -40,6 +40,7 @@ requests = "*"
|
||||
coverage = ">=6.5,<8.0"
|
||||
httpx = "*"
|
||||
tox = "^4.5.1"
|
||||
towncrier = "^22.12.0"
|
||||
|
||||
[tool.poetry.group.distributing]
|
||||
optional = true
|
||||
@@ -76,6 +77,16 @@ strict_concatenate = true
|
||||
module = "examples.*.main"
|
||||
ignore_errors = true
|
||||
|
||||
[tool.towncrier]
|
||||
directory = "changelog.d"
|
||||
filename = "CHANGELOG.md"
|
||||
package = "fastapi_cache"
|
||||
start_string = "<!-- towncrier release notes start -->\n"
|
||||
underlines = ["", "", ""]
|
||||
template = "changelog.d/changelog_template.jinja"
|
||||
title_format = "## [{version}](https://github.com/long2ice/fastapi-cache/tree/{version}) - {project_date}"
|
||||
issue_format = "[#{issue}](https://github.com/long2ice/fastapi-cache/issues/{issue})"
|
||||
|
||||
[tool.pyright]
|
||||
strict = ["fastapi_cache", "tests"]
|
||||
pythonVersion = "3.7"
|
||||
|
||||
Reference in New Issue
Block a user