# git-cliff ~ default configuration file # https://git-cliff.org/docs/configuration # # Lines starting with "#" are comments. # Configuration options are organized into tables and keys. # See documentation for more information on available options. [bump] features_always_bump_minor = true breaking_always_bump_major = true [changelog] # changelog header header = """ # Changelog\n """ # template for the changelog body # https://keats.github.io/tera/docs/#introduction body = """ {% if version %}\ ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} {% else %}\ ## [unreleased] {% endif %}\ {% 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.links %}\ {% for link in commit.links %}\ [{{ link.text }}]({{ link.href }}) \ {% if not loop.last %}, {% endif %}\ {% endfor %}\ {% endif %}\ ([{{ commit.id | truncate(length=7, end="") }}]($REPO/-/commit/{{ commit.id }}))\ {% endfor %} {% endfor %}\n """ # template for the changelog footer footer = """ <!-- generated by git-cliff --> """ # remove the leading and trailings trim = true # postprocessors postprocessors = [ { pattern = '\$REPO', replace = "https://git.perx.ru/perxis/perxis-go" }, ] [git] # parse the commits based on https://www.conventionalcommits.org conventional_commits = true # 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 = [ { pattern = 'Feat:', replace = "feat:"}, { pattern = 'WIP:', replace = ""}, { pattern = 'wip:', replace = ""} # Replace issue numbers #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/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 = "<!-- 0 -->🚀 Новые возможности" }, { message = "^fix", group = "<!-- 1 -->🐛 Исправлены ошибки" }, { message = "^doc", group = "<!-- 3 -->📚 Документация" }, { message = "^perf", group = "<!-- 4 -->⚡ Производительность" }, { message = "^refactor", group = "<!-- 2 -->🚜 Рефакторинг", skip = true }, { message = "^style", group = "<!-- 5 -->🎨 Styling" }, { message = "^test", group = "<!-- 6 -->🧪 Тесты" }, { message = "^chore\\(release\\): prepare for", skip = true }, { message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore\\(pr\\)", skip = true }, { message = "^chore\\(pull\\)", skip = true }, { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Прочие задачи" }, { body = ".*security", group = "<!-- 8 -->🛡️ Безопастность" }, { message = "^revert", group = "<!-- 9 -->◀️ Отменены изменения" }, { message = "^irefac", skip = true }, ] # 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 = "v0.([0-9]\\.|1[0-8]).*" # regex for ignoring tags # ignore_tags = "" # sort the tags topologically topo_order = false # sort the commits inside sections by oldest/newest order sort_commits = "oldest" # limit the number of commits included in the changelog. # limit_commits = 42 link_parsers = [ { pattern = "#(\\d+)", href = "https://git.perx.ru/perxis/perxis/-/issues/$1"}, { pattern = "#(PRXS-(\\d+))", href = "https://tracker.yandex.ru/$1"}, { pattern = "RFC(\\d+)", text = "ietf-rfc$1", href = "https://datatracker.ietf.org/doc/html/rfc$1"}, ] [remote.gitlab] owner = "perxis" repo = "perxis-go" api_url = "https://git.perx.ru/api/v4/"