# git-cliff Configuration File # https://git-cliff.org/docs/configuration [remote.github] owner = "nicholas-fedor" repo = "shoutrrr" [changelog] # ────────────────────────────────────────────────────────────── # A Tera template to be rendered as the changelog's header. # See https://keats.github.io/tera/docs/#introduction # ────────────────────────────────────────────────────────────── header = """ # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). """ # ────────────────────────────────────────────────────────────── # A Tera template to be rendered for each release in the changelog. # See https://keats.github.io/tera/docs/#introduction # ────────────────────────────────────────────────────────────── body = """ {%- macro remote_url() -%} https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} {%- endmacro -%} {% if version %} ## [{{ version | trim_start_matches(pat="v") }}] - {% if commits | length > 0 %}{{ commits[0].committer.timestamp | date(format="%Y-%m-%d") }}{% else %}{{ timestamp | date(format="%Y-%m-%d") }}{% endif %} {% else %} ## [Unreleased] {% endif -%} {% for group, commits in commits | group_by(attribute="group") %} ### {{ group | upper_first }} {% for commit in commits %} - {{ commit.message | split(pat="\n") | first | upper_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 %} {% endfor -%} {%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} ### 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 %} {%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}{{"\n"}}{% endif %} """ # ────────────────────────────────────────────────────────────── # A Tera template to be rendered as the changelog's footer. # See https://keats.github.io/tera/docs/#introduction # ────────────────────────────────────────────────────────────── footer = """ ## Compare Releases {% macro remote_url() -%} https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} {%- endmacro -%} {% for release in releases -%} {% if release.version -%} {% if release.previous and release.previous.version -%} - [{{ release.version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }}) {% endif -%} {% else -%} {% if release.previous and release.previous.version -%} - [unreleased]({{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD) {% endif -%} {% endif -%} {% endfor %} """ # Remove leading and trailing whitespaces from the changelog's body. trim = true [git] # Parse commits according to the conventional commits specification. # See https://www.conventionalcommits.org conventional_commits = true # Exclude commits that do not match the conventional commits specification. filter_unconventional = false commit_preprocessors = [{ pattern = '\s*\((\w+\s)?#([0-9]+)\)', replace = "" }] commit_parsers = [ # Skip changelog updates (noise from generation/merges) { message = "(?i)update.*changelog", skip = true }, { field = "remote.username", pattern = "renovate\\[bot\\]", group = "Chores" }, { message = "^chore", group = "Chores" }, { message = "^.*: chore", group = "Chores" }, { message = "(?i)^fix.*update module", group = "Chores" }, { message = "(?i)^fix.*update dependency", group = "Chores" }, { message = "(?i)^fix.*bump.*from.*to", group = "Chores" }, { message = "(?i)update module", group = "Chores" }, { message = "(?i)update dependency", group = "Chores" }, { message = "(?i)bump.*from.*to", group = "Chores" }, { message = "^fix", group = "Fixed" }, { message = "^.*: fix", group = "Fixed" }, { message = "^[aA]dd", group = "Added" }, { message = "^[sS]upport", group = "Added" }, { message = "^[rR]emove", group = "Removed" }, { message = "^.*: add", group = "Added" }, { message = "^.*: support", group = "Added" }, { message = "^.*: remove", group = "Removed" }, { message = "^.*: delete", group = "Removed" }, { message = "^test", group = "Tests" }, { message = "^.*", group = "Changed" }, ] # Exclude commits that are not matched by any commit parser. filter_commits = true # Order releases topologically instead of chronologically. topo_order = false # Order of commits in each group/release within the changelog. # Allowed values: newest, oldest sort_commits = "newest"