# git-cliff ~ configuration # https://git-cliff.org/docs/configuration [changelog] header = "" body = """ {%- macro remote_url() -%} https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} {%- endmacro -%} {%- set excluded_users = ["github-actions[bot]", "dependabot[bot]", "renovate[bot]"] -%} {% macro print_commit(commit) -%} - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ {% if commit.breaking %}[**breaking**] {% endif %}\ {{ commit.message | upper_first }} - \ ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ {% endmacro -%} {% if version %}\ {% if previous.version %}\ ## [{{ version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} {% else %}\ ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} {% endif %}\ {% else %}\ ## [unreleased] {% endif %}\ {%- for group, commits in commits | group_by(attribute="group") %} ### {{ group | striptags | trim | upper_first }} {%- for commit in commits | filter(attribute="scope") | sort(attribute="scope") %} {{ self::print_commit(commit=commit) }} {%- endfor %} {%- for commit in commits %} {%- if not commit.scope -%} {{ self::print_commit(commit=commit) }} {%- endif -%} {%- endfor -%} {%- endfor -%} {%- set valid_contributors = [] -%} {%- for c in github.contributors | filter(attribute="is_first_time", value=true) %} {%- if c.username and c.username not in excluded_users and c.username not in valid_contributors %} {%- set_global valid_contributors = valid_contributors | concat(with=c.username) %} {%- endif %} {%- endfor %} {%- if valid_contributors | length > 0 %} ## New Contributors โค๏ธ {%- for username in valid_contributors %} * @{{ username }} made their first contribution {%- endfor %} {%- endif %} """ footer = """ """ trim = true postprocessors = [] [git] conventional_commits = true filter_unconventional = true split_commits = false filter_commits = true commit_preprocessors = [ { pattern = '.*\[skip ci\].*', replace = "" }, { pattern = '.*\[ci skip\].*', replace = "" }, ] commit_parsers = [ { message = "^feat", group = "๐Ÿš€ Features" }, { message = "^fix", group = "๐Ÿ› Bug Fixes" }, { message = "^doc", group = "๐Ÿ“– Documentation" }, { message = "^perf", group = "โšก Performance" }, { message = "^refactor", group = "๐Ÿšœ Refactor" }, { message = "^style", group = "๐ŸŽจ Styling" }, { message = "^test", group = "๐Ÿงช Testing" }, { message = "^chore\\(release\\): prepare for", skip = true }, { message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore\\(pr\\)", skip = true }, { message = "^chore\\(pull\\)", skip = true }, { message = "^chore\\(git-sync\\)", skip = true }, { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, { message = "^revert", group = "โ—€๏ธ Revert" }, { message = '.*\[skip ci\].*', skip = true }, { message = '.*\[ci skip\].*', skip = true }, ] protect_breaking_commits = false tag_pattern = "v?[0-9]+\\.[0-9]+\\.[0-9]+.*" skip_tags = "beta|alpha|rc" topo_order = false sort_commits = "newest"