name: Changelog

# Regenerate CHANGELOG.md on every push to main.

# Tags (v*.*.*) are treated as release versions by git-cliff.

on:

  push:

    branches:

      - main

    tags-ignore:

      - '**'

permissions:

  contents: write

concurrency:

  group: changelog-${{ github.ref }}

  cancel-in-progress: true

jobs:

  changelog:

    runs-on: ubuntu-latest

    # Avoid loops: skip the commit this workflow itself pushes.

    if: github.actor != 'github-actions[bot]'

    steps:

      - name: Checkout

        uses: actions/checkout@v6

        with:

          fetch-depth: 0

          persist-credentials: true

      - name: Generate changelog

        uses: orhun/git-cliff-action@v4

        with:

          config: cliff.toml

          args: --verbose

        env:

          OUTPUT: CHANGELOG.md

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Commit changelog

        run: |

          git config user.name "github-actions[bot]"

          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

          if git diff --quiet CHANGELOG.md; then

            echo "No changelog changes."

            exit 0

          fi

          git add CHANGELOG.md

          git commit -m "chore: update changelog [skip ci]"

          git push

# git-cliff ~ configuration file

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

[changelog]

header = """

# Changelog\n

All notable changes to this project will be documented in this file.\n

"""

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 }}\

    {% endfor %}

{% endfor %}\n

"""

trim = true

footer = """

<!-- generated by git-cliff -->

"""

[git]

conventional_commits = true

filter_unconventional = true

split_commits = false

commit_preprocessors = []

commit_parsers = [

  { message = "^feat", group = "<!-- 0 -->Features" },

  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },

  { message = "^doc", group = "<!-- 3 -->Documentation" },

  { message = "^perf", group = "<!-- 4 -->Performance" },

  { message = "^refactor", group = "<!-- 2 -->Refactor" },

  { message = "^style", group = "<!-- 5 -->Styling" },

  { message = "^test", group = "<!-- 6 -->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 = "<!-- 7 -->Miscellaneous Tasks" },

  { body = ".*security", group = "<!-- 8 -->Security" },

  { message = "^revert", group = "<!-- 9 -->Revert" },

]

protect_breaking_commits = false

filter_commits = false

tag_pattern = "v[0-9].*"

skip_tags = ""

ignore_tags = ""

topo_order = false

sort_commits = "oldest"