cliff.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 %}
{#  #}

{%- set_global commit_message = "" -%}
{%- set_global commit_author = "" -%}
{%- set_global outside_pr = true -%}
{% for commit in commits %}
  {%- if commit.github.pr_labels is containing("skip-release-notes") -%}
      {%- continue -%}
  {%- endif -%}
  {%- if commit.message | split(pat="\n") | first | trim == commit_message -%}
    {%- if commit.github.username == commit_author -%}
      {%- continue -%}
    {%- elif commit.github.username == "" -%}
      {%- continue -%}
    {%- elif commit.github.username -%}
    {% else %}
      {%- continue -%}
    {%- endif -%}
  {%- endif -%}
  {%- if commit.message | trim | split(pat="\n") | last | trim == "changelog: ignore" -%}
    {%- continue -%}
  {%- endif -%}
  {%- if commit.github.pr_title -%}
    {%- set_global commit_message = commit.github.pr_title | split(pat="\n") | first | trim -%}
    {%- set_global outside_pr = false -%}
  {%- else -%}
    {%- set_global commit_message = commit.message | split(pat="\n") | first | trim -%}
  {%- endif %}
  {% if outside_pr or commit.github.pr_title %}{% else %}  {% endif %}- {{ commit_message }}\
    {% if commit.github.username %},{% set_global commit_author = commit.github.username %} by @{{ commit.github.username }}{%- endif -%}
    {% if commit.github.pr_number %}, in \
      [#{{ commit.github.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.github.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
  # 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 = "" },
  ]
  # protect breaking changes from being skipped due to matching a skipping commit_parser
  protect_breaking_commits = false
  # filter out the commits that are not matched by commit parsers
  filter_commits = false
  # regex for matching git tags
  tag_pattern = "v[0-9].*"
  # regex for skipping tags
  skip_tags = "beta|alpha"
  # regex for ignoring tags
  ignore_tags = "rc"
  # sort the tags topologically
  topo_order = false
  # sort the commits inside sections by oldest/newest order
  sort_commits = "newest"


[remote.github]
  owner = "jovandeginste"
  repo  = "workout-tracker"