From f4418f3b00daf625e7df15a8d1c831100ba18d4e Mon Sep 17 00:00:00 2001 From: Kristoffer Andersson Date: Fri, 22 Nov 2024 14:54:28 +0100 Subject: [PATCH] chore: config git-cliff to use Keep-a-changelog format --- cliff.toml | 98 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 67 insertions(+), 31 deletions(-) diff --git a/cliff.toml b/cliff.toml index b2a0587..ed49e75 100644 --- a/cliff.toml +++ b/cliff.toml @@ -4,16 +4,26 @@ # Lines starting with "#" are comments. # Configuration options are organized into tables and keys. # See documentation for more information on available options. +[remote.github] +owner = "spraakbanken" +repo = "sparv-sbx-sentiment-analysis" [changelog] # changelog header header = """ # Changelog\n -All notable changes to this project will be documented in this file.\n +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.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n """ # template for the changelog body # 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") }}] - {{ timestamp | date(format="%Y-%m-%d") }} {% else %}\ @@ -22,22 +32,42 @@ body = """ {% for group, commits in commits | group_by(attribute="group") %} ### {{ group | striptags | trim | upper_first }} {% for commit in commits %} - - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ - {% if commit.breaking %}[**breaking**] {% endif %}\ - {{ commit.message | upper_first }}\ + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | split(pat="\n") | first | upper_first | trim }}\ + {% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ 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 %}\n +{% 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 %}\n """ -# remove the leading and trailing whitespace from the template -trim = true -# changelog footer +# template for the changelog footer footer = """ """ +# remove the leading and trailing s +trim = true # postprocessors postprocessors = [ - # { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL + # { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL ] + +[bump] +features_always_bump_minor = true +breaking_always_bump_major = false + [git] # parse the commits based on https://www.conventionalcommits.org conventional_commits = true @@ -47,39 +77,45 @@ filter_unconventional = true split_commits = false # regex for preprocessing the commit messages commit_preprocessors = [ - { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))" }, # replace issue numbers + # Replace issue numbers + #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))"}, + # Check spelling of the commit with https://github.com/crate-ci/typos + # If the spelling is incorrect, it will be automatically fixed. + #{ pattern = '.*', replace_command = 'typos --write-changes -' }, ] # regex for parsing and grouping commits commit_parsers = [ - { message = "^feat", group = "Added" }, - { message = "^fix", group = "Fixed" }, - { message = "^doc", group = "Documentation" }, - { message = "^perf", group = "Performance" }, - { message = "^refactor", group = "Changed" }, - { message = "^style", group = "Styling" }, - { message = "^test", group = "Testing" }, - { message = "^chore\\(release.*\\): prepare for", skip = true }, - { message = "^chore\\(release.*\\): Bump version", skip = true }, - { message = "^chore\\(deps.*\\)", skip = true }, - { message = "^chore\\(pr\\)", skip = true }, - { message = "^chore\\(pull\\)", skip = true }, - { message = "^chore|ci", group = "Miscellaneous Tasks" }, - { body = ".*security", group = "Security" }, - { message = "^revert", group = "Revert" }, + { message = "^feat", group = "Added" }, + { message = "^.*: remove", group = "Removed" }, + { message = "^.*: delete", group = "Removed" }, + { message = "^fix", group = "Fixed" }, + { message = "^doc", group = "Documentation" }, + { message = "^perf", group = "Changed" }, + { message = "^refactor", group = "Changed" }, + { message = "^style", group = "Internal" }, + { message = "^test", group = "Internal" }, + { message = "^chore\\(release.*\\): prepare for", skip = true }, + { message = "^chore\\(release.*\\): Bump version", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "Internal", skip = true }, + { body = ".*security", group = "Security" }, + { message = "^revert", group = "Changed" }, ] # 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 -# glob pattern for matching git tags -# tag_pattern = "v[0-9]*" +# regex for matching git tags +# tag_pattern = "ocr-correction-viklofg-sweocr-v[0-9].*" # regex for skipping tags -# skip_tags = "v0.1.0-beta.1" +# skip_tags = "" # regex for ignoring tags -ignore_tags = "" +# ignore_tags = "" # sort the tags topologically -topo_order = false +topo_order = true # sort the commits inside sections by oldest/newest order -sort_commits = "oldest" +sort_commits = "newest" # limit the number of commits included in the changelog. # limit_commits = 42