mirror of
https://github.com/orhun/git-cliff.git
synced 2024-11-29 13:32:20 +03:00
87e2c1d0dd
* feat(core): add `remote` field to commit * refactor * fmt * deprecate old fields * serialize remote field * fix * fix typo * allow deprecated * move warn * move filename * docs * docs * fix * fmt * chore(fixtures): use remote instead of platform name for template variables * remove useless method * update docs * use contains_variable * fix no-default-features * chore(remote): update template varibles for platforms * set commit.remote * chore(release): update unit tests for new remote field --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
81 lines
2.5 KiB
TOML
81 lines
2.5 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
# [remote.github]
|
|
# owner = "orhun"
|
|
# repo = "git-cliff"
|
|
# token = ""
|
|
|
|
[changelog]
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
## What's Changed
|
|
|
|
{%- if version %} in {{ version }}{%- endif -%}
|
|
{% for commit in commits %}
|
|
{% if commit.remote.pr_title -%}
|
|
{%- set commit_message = commit.remote.pr_title -%}
|
|
{%- else -%}
|
|
{%- set commit_message = commit.message -%}
|
|
{%- endif -%}
|
|
* {{ commit_message | split(pat="\n") | first | trim }}\
|
|
{% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
|
|
{% if commit.remote.pr_number %} in \
|
|
[#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \
|
|
{%- endif %}
|
|
{%- endfor -%}
|
|
|
|
{%- if github -%}
|
|
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
|
|
{% raw %}\n{% endraw -%}
|
|
## New Contributors
|
|
{%- endif %}\
|
|
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
|
|
* @{{ contributor.username }} made their first contribution
|
|
{%- if contributor.pr_number %} in \
|
|
[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
|
|
{%- endif %}
|
|
{%- endfor -%}
|
|
{%- endif -%}
|
|
|
|
{% if version %}
|
|
{% if previous.version %}
|
|
**Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
|
|
{% endif %}
|
|
{% else -%}
|
|
{% raw %}\n{% endraw %}
|
|
{% endif %}
|
|
|
|
{%- macro remote_url() -%}
|
|
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
|
|
{%- endmacro -%}
|
|
"""
|
|
# remove the leading and trailing whitespace from the template
|
|
trim = true
|
|
# template for the changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# postprocessors
|
|
postprocessors = []
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = false
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = true
|
|
# process each line of a commit as an individual commit
|
|
split_commits = false
|
|
# regex for preprocessing the commit messages
|
|
commit_preprocessors = [
|
|
# remove issue numbers from commits
|
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
|
|
]
|
|
# filter out the commits that are not matched by commit parsers
|
|
filter_commits = false
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "newest"
|