Added git-cliff configuration and script
This commit is contained in:
parent
742c221a20
commit
c69d7b7076
2 changed files with 90 additions and 0 deletions
10
cliff.fish
Executable file
10
cliff.fish
Executable file
|
@ -0,0 +1,10 @@
|
||||||
|
#!/usr/bin/env fish
|
||||||
|
|
||||||
|
set scriptname (basename (status -f))
|
||||||
|
|
||||||
|
if test (count $argv) -eq 1
|
||||||
|
git cliff --unreleased --tag "$argv"
|
||||||
|
else
|
||||||
|
echo "Usage: $scriptname <tag>"
|
||||||
|
exit 2
|
||||||
|
end
|
80
cliff.toml
Normal file
80
cliff.toml
Normal file
|
@ -0,0 +1,80 @@
|
||||||
|
# git-cliff ~ configuration file
|
||||||
|
# https://git-cliff.org/docs/configuration
|
||||||
|
|
||||||
|
[remote.github]
|
||||||
|
owner = "ethauvin"
|
||||||
|
repo = "urlencoder"
|
||||||
|
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 }}) \
|
||||||
|
{%- else %} in \
|
||||||
|
[{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}) \
|
||||||
|
{%- 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 = ""
|
||||||
|
# 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"
|
Loading…
Add table
Add a link
Reference in a new issue