update-available 0.2.0

# git-cliff ~ configuration file

# https://git-cliff.org/docs/configuration



[remote.github]

owner = "bircni"

repo = "update-available"



[changelog]

# A Tera template to be rendered as the changelog's footer.

# See https://keats.github.io/tera/docs/#introduction

header = """
# Changelog - [update-available]($REPO)\n
All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
"""

# A Tera template to be rendered for each release in the changelog.

# See https://keats.github.io/tera/docs/#introduction

body = """

{% if version %}\

    {% if previous.version %}\

        ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% else %}\

        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
    {% endif %}\

{% else %}\

    ## [unreleased]
{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \

            {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\

    {%- for commit in commits %}
        {%- if commit.scope -%}
        {% else -%}
            - {% if commit.breaking %} [**breaking**]{% endif %}\

                {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
        {% endif -%}
    {% endfor -%}
{% endfor %}
"""



# Remove leading and trailing whitespaces from the changelog's body.

trim = true

postprocessors = [

    # Replace the placeholder `<REPO>` with a URL.

    { pattern = '\$REPO', replace = "https://github.com/bircni/update-available" }, # replace repository URL

]





[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

# 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}](https://github.com/orhun/git-cliff/issues/${2}))"},

]

# 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 = "Refactoring" },

    { message = "^style", group = "Style" },

    { message = "^revert", group = "Revert" },

    { message = "^test", group = "Tests" },

    { message = "^release.*", skip = true },

    { message = "^chore", group = "Miscellaneous Chores" },

    { body = ".*security", group = "Security" },

]

# Exclude commits that are not matched by any commit parser.

filter_commits = false

# Order releases topologically instead of chronologically.

topo_order = false

# Order of commits in each group/release within the changelog.

# Allowed values: newest, oldest

sort_commits = "oldest"