Skip to content

Commit

Permalink
Shifting git cliff changelog generator configuration to pyproject.toml (
Browse files Browse the repository at this point in the history
#2711)

Shifting git cliff configuration to pyproject.toml
  • Loading branch information
KasukabeDefenceForce authored Jul 19, 2024
1 parent 8cc2f9f commit 14b52c5
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/post-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Generate a changelog
uses: orhun/git-cliff-action@v3
with:
config: cliff.toml
config: pyproject.toml
args: --verbose
env:
OUTPUT: CHANGELOG.md
Expand Down
23 changes: 0 additions & 23 deletions cliff.toml

This file was deleted.

24 changes: 23 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,26 @@ markers = [
]

[tool.tardis]
edit_on_github = false
edit_on_github = false

[tool.git-cliff.changelog]
header = "## Changelog\n\n"
body = """
### {{version}} ({{ timestamp | date(format="%Y/%m/%d %H:%M", timezone="America/New_York") }})
{% for commit in commits %}
{%- if commit.github.pr_number -%}
- [{{commit.github.pr_number}}](https://github.com/tardis-sn/tardis/pull/{{commit.github.pr_number}}) {{ commit.github.pr_title | split(pat="\n") | first | trim }} ({{commit.github.pr_number}}) (@{{ commit.github.username }})
{% endif -%}
{%- endfor -%}
"""
trim = true
footer = "<!-- generated by git-cliff -->"

[tool.git-cliff.git]
conventional_commits = false
filter_unconventional = false
sort_commits = "newest"

[tool.git-cliff.remote.github]
owner = "tardis-sn"
repo = "tardis"

0 comments on commit 14b52c5

Please sign in to comment.