# git-cliff ~ configuration file # https://git-cliff.org/docs/configuration [remote.github] owner = "89jobrien" repo = "notfiles" [changelog] 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 | upper_first }} {% for commit in commits %} - {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\ {{ commit.message | split(pat="\n") | first | upper_first | trim_end }}\ {% if commit.links %} \ ({% for link in commit.links %}[#{{ link.text }}]({{ link.href }}){% if not loop.last %}, {% endif %}{% endfor %})\ {% endif %}\ {% endfor %} {% endfor %}\n """ footer = """ {%- macro remote_url() -%} https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} {%- endmacro -%} {% for release in releases -%} {% if release.version -%} {% if release.previous.version -%} [{{ release.version | trim_start_matches(pat="v") }}]: \ {{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }} {% endif -%} {% else -%} [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD {% endif -%} {% endfor %} """ trim = true render_always = true output = "CHANGELOG.md" postprocessors = [ { pattern = '', replace = "https://github.com/89jobrien/notfiles" }, ] [git] conventional_commits = true filter_unconventional = true require_conventional = false split_commits = false protect_breaking_commits = false filter_commits = false fail_on_unmatched_commit = false use_branch_tags = false topo_order = false topo_order_commits = true sort_commits = "oldest" recurse_submodules = false commit_preprocessors = [ { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))" }, ] commit_parsers = [ { message = "^feat", group = "Features" }, { message = "^fix", group = "Bug Fixes" }, { message = "^refactor", group = "Refactor" }, { message = "^doc", group = "Documentation" }, { message = "^perf", group = "Performance" }, { message = "^style", group = "Styling" }, { message = "^test", group = "Testing" }, { message = "^chore\\(release\\):.*", skip = true }, { message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore\\(pr\\)", skip = true }, { message = "^chore\\(pull\\)", skip = true }, { message = "^chore|^ci", group = "Miscellaneous" }, { body = ".*security", group = "Security" }, { message = "^revert", group = "Reverts" }, { message = ".*", group = "Other" }, ] link_parsers = [ { pattern = "#(\\d+)", href = "https://github.com/89jobrien/notfiles/issues/$1", text = "$1" }, ]