# git-cliff ~ configuration file # https://git-cliff.org/docs/configuration [changelog] # A Tera template to be rendered for each release in the changelog. # See https://keats.github.io/tera/docs/#introduction body = """ {% if version %}\ ## [{{ version | trim_start_matches(pat="v") }}](/compare/v{{ previous.version | trim_start_matches(pat="v") }}...v{{ 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 }}\ {% endfor %} {% endfor %} """ # Remove leading and trailing whitespaces from the changelog's body. trim = true # Render body even when there are no releases to process. render_always = true # An array of regex based postprocessors to modify the changelog. postprocessors = [ # Replace the placeholder with a URL. { pattern = '', replace = "https://github.com/KRTirtho/spotube" }, ] # render body even when there are no releases to process # render_always = true # output file path # output = "test.md" [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 = true # Require all commits to be conventional. # Takes precedence over filter_unconventional. require_conventional = false # Split commits on newlines, treating each line as an individual commit. split_commits = false # An array of regex based parsers to modify commit messages prior to further processing. commit_preprocessors = [ # Replace issue numbers with link templates to be updated in `changelog.postprocessors`. { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))" }, # Check spelling of the commit message using https://github.com/crate-ci/typos. # If the spelling is incorrect, it will be fixed automatically. #{ pattern = '.*', replace_command = 'typos --write-changes -' }, ] # Prevent commits that are breaking from being excluded by commit parsers. protect_breaking_commits = false # An array of regex based parsers for extracting data from the commit message. # Assigns commits to groups. # Optionally sets the commit's scope and can decide to exclude commits from further processing. 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|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, # { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, # { message = "^revert", group = "โ—€๏ธ Revert" }, # { message = ".*", group = "๐Ÿ’ผ Other" }, ] # Exclude commits that are not matched by any commit parser. filter_commits = true # An array of link parsers for extracting external references, and turning them into URLs, using regex. link_parsers = [] # Include only the tags that belong to the current branch. use_branch_tags = false # Order releases topologically instead of chronologically. topo_order = false # Order releases topologically instead of chronologically. topo_order_commits = true # Order of commits in each group/release within the changelog. # Allowed values: newest, oldest sort_commits = "oldest" # Process submodules commits recurse_submodules = false