cliff.toml

# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
#
# Commit format: [JIRA-TICKET] | [TYPE][(scope)][!]: <MESSAGE>
# Examples:
#   OCM-12345 | feat: add new feature
#   OCM-12345 | feat(cluster): add new feature
#   OCM-12345 | feat!: breaking change

[changelog]
# Changelog header
# Template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{%- if version -%}
## {{ version | trim_start_matches(pat="v") }} ({{ timestamp | date(format="%d %b, %Y") }})
{%- else -%}
## [unreleased]
{%- endif -%}
{%- for group, commits in commits | group_by(attribute="group") %}

{{ group | striptags | trim | upper  }}
{%- for group, commits in commits | group_by(attribute="scope") %}
{%- if not (group is containing("Ignore")) %}
 * {{ group | upper_first }}
   {%- for commit in commits %}
   * {{ commit.message | upper_first | split(pat="\n") | first }}\
   {% endfor %}
{%- else%}
{%- for commit in commits %}
   * {{ commit.message | upper_first }}\n
{%- endfor -%}
{%- endif%}
{%- endfor %}
{%- endfor %}\n
"""
# Remove leading and trailing whitespaces from the changelog
trim = false
# Render body even when there are no releases to process
render_always = false
# Postprocessors for final changelog modifications
postprocessors = []

[git]
# Use conventional commits parsing to extract type and description
conventional_commits = true
# Do not filter unconventional commits
filter_unconventional = false
# Do not require conventional commits
require_conventional = false
# Do not split commits on newlines
split_commits = false

# Preprocessors to transform commit messages from our format to parseable format
# Transform: "OCM-12345 | feat(scope)!: add feature" -> "feat(scope)!: add feature"
# (Must match hack/commit-msg-verify.sh: optional (scope) and ! before the colon.)
# This allows commit_parsers to match on type while preserving the message
commit_preprocessors = [
    # JIRA-XXXX | type[(scope)][!]: body -> conventional subject for parsing
    { pattern = '^[A-Z]+-\d+\s*\|\s*(feat|fix|docs|style|refactor|perf|test|build|ci|chore)(\([a-z0-9._-]+\))?(!)?:\s*(.+)$', replace = "$1$2$3: $4" },
    # Placeholder OCM-0… ticket (same shape)
    { pattern = '^OCM-0+\s*\|\s*(feat|fix|docs|style|refactor|perf|test|build|ci|chore)(\([a-z0-9._-]+\))?(!)?:\s*(.+)$', replace = "$1$2$3: $4" },
    # Strip "OCM-NNNN: " prefix (e.g. "OCM-3102: Fixing a bug" -> "Fixing a bug")
    { pattern = '^[A-Z]+-\d+:\s*', replace = "" },
    { pattern = '^[A-Z]+-\d+ \| \s*', replace = "" },
    # Remove Signed-off-by lines (e.g. "Signed-off-by: abc <abc@abc.com>")
    { pattern = 'Signed-off-by:.*>', replace = "" },
]

# Commit parsers to group commits by type
commit_parsers = [
    # Skip test commits - they're not user-facing
    { message = "^test", skip = true },
    # Skip CI/CD commits - they're internal
    { message = "^ci", skip = true },
    # Skip build commits - they're internal
    { message = "^build", skip = true },
    # Skip anything mentioning konflux (case insensitive)
    { message = "(?i).*konflux.*", skip = true },
    # Skip anything mentioning changelog (case insensitive)
    { message = "(?i).*changelog.*", skip = true },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore\\(deps", skip = true },
    # Skip single-word messages (e.g. "F", "Init", "something")
    { message = "^\\S+$", skip = true },
    # Skip merge commits
    { message = "^Merge pull request", skip = true },
    { message = "^Merge branch", skip = true },
    { message = "^Merge remote-tracking branch", skip = true },
    { message = "Update README.md", skip = true},

    # Commits to be added to Changelog
    # <!-- 1 --> entries are used to force an order
    # Setting scope as a way to create subcategories
    { message = "^feat", group = "<!-- 1 -->FEATURES:", default_scope="Ignore scope"},
    { message = "^fix", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Bug fixes"},
    { message = "^docs", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Documentation"},
    { message = "^perf", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Chores"},
    { message = "^refactor", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Chores"},
    { message = "^style", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Chores"},
    { message = "^chore", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Chores"},
    { body = ".*security", group = "<!-- 4 -->SECURITY:", default_scope="Ignore scope"},
    { message = "^revert", group = "<!-- 5 -->REVERTS:", default_scope="Ignore scope"},
    # Parsers for not conventional commits
    { message = "(?i).*documentation.*", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Documentation"},
    { message = "(?i)(^|.*\\s)fix(\\s|:)", group = "<!-- 2 -->ENHANCEMENTS:", default_scope="Bug fixes"},
    # if no match, will be added as Other
    { message = ".*", group = "<!-- 2 -->ENHANCEMENTS:", default_scope = "Other"},
    
]

# Protect breaking changes from being skipped
protect_breaking_commits = false
# Filter out commits that don't match any parser
filter_commits = true
# Do not fail on unmatched commits
fail_on_unmatched_commit = false
# Link parsers for external references
link_parsers = [
    # Parse JIRA ticket references
    { pattern = "OCM-(\\d+)", href = "https://issues.redhat.com/browse/OCM-$1" },
]
# Use tags from current branch only
use_branch_tags = false
# Regex pattern for matching git tags
tag_pattern = "v[0-9].*"
# Skip tags in output (but still process their commits)
skip_tags = ""
# Completely ignore prerelease, test, and hotfix tags (don't use them as boundaries)
ignore_tags = ".*(-prerelease\\.|-test|-hotfix).*"
# Sort tags topologically
topo_order = false
# Sort commits topologically
topo_order_commits = false
# Sort commits within groups (newest first matches existing changelog)
sort_commits = "newest"
# Do not process submodules
recurse_submodules = false