feat: semver (#7)

[changelog]

# changelog header

header = """

# Changelog\n

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

"""

# template for the changelog body

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

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

"""

# template for the changelog footer

footer = """

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

"""

# remove the leading and trailing s

trim = true

[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = true

# process each line of a commit as an individual commit

split_commits = false

# regex for parsing and grouping commits

commit_parsers = [

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

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

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

  { message = "^doc.*update changelog.*",             group = "<!-- 3 -->📚 Documentation", skip = true },

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

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

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

  { message = "^test",                                group = "<!-- 6 -->🧪 Testing" },

  { message = "^chore|^ci",                           group = "<!-- 7 -->⚙️ Miscellaneous Tasks", skip = true },

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

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

  { message = "^chore\\(release\\): prepare for", skip = true },

  { message = "^chore\\(deps.*\\)",               skip = true },

  { message = "^chore\\(pr\\)",                   skip = true },

  { message = "^chore\\(pull\\)",                 skip = true },

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = true

# filter out the commits that are not matched by commit parsers

filter_commits = true

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "newest"

# limit the number of commits included in the changelog.

limit_commits = 100000

[changelog]

# template for the changelog body

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

body = """

{% 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 the leading and trailing s

trim = true

[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = true

# process each line of a commit as an individual commit

split_commits = false

# regex for parsing and grouping commits

commit_parsers = [

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

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

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

  { message = "^doc.*update changelog.*",             group = "<!-- 3 -->📚 Documentation", skip = true },

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

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

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

  { message = "^test",                                group = "<!-- 6 -->🧪 Testing" },

  { message = "^chore|^ci",                           group = "<!-- 7 -->⚙️ Miscellaneous Tasks", skip = true },

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

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

  { message = "^chore\\(release\\): prepare for", skip = true },

  { message = "^chore\\(deps.*\\)",               skip = true },

  { message = "^chore\\(pr\\)",                   skip = true },

  { message = "^chore\\(pull\\)",                 skip = true },

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = true

# filter out the commits that are not matched by commit parsers

filter_commits = true

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "newest"

# limit the number of commits included in the changelog.

limit_commits = 100000

version: 2

updates:

  - package-ecosystem: "pip" # See documentation for possible values

    directory: "/.requirements" # Location of package manifests

  - package-ecosystem: "pip"

    directory: "/.requirements"

    schedule:

      interval: "weekly"

    labels:

      - "dependencies"

  - package-ecosystem: "github-actions"

    directory: "/"

    directory: "/.github/workflows"

    schedule:

      interval: "daily"

      interval: "weekly"

    labels:

      - "dependencies"

name: Push [create tag]

"on":

  push:

    branches:

      - main

concurrency:

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

  cancel-in-progress: false

jobs:

  merge:

    name: Push [create tag]

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        if: "${{ ! startsWith(github.event.head_commit.message, 'docs: update changelog for ') }}"

        uses: actions/checkout@v4.1.6

        with:

          token: ${{ secrets.PAT }}

          fetch-depth: 0

      - name: Get Next Version

        if: "${{ ! startsWith(github.event.head_commit.message, 'docs: update changelog for ') }}"

        id: semver

        uses: ietf-tools/semver-action@v1.8.0

        with:

          token: ${{ github.token }}

          branch: main

          noVersionBumpBehavior: silent

          noNewCommitBehavior: silent

      - name: Update CHANGELOG.md

        if: "${{ ! startsWith(github.event.head_commit.message, 'docs: update changelog for ') && steps.semver.outputs.next != '' }}"

        uses: orhun/git-cliff-action@v4

        with:

          config: .cliff.git.toml

          args: --tag ${{ steps.semver.outputs.next }}

        env:

          OUTPUT: CHANGELOG.md

      - uses: EndBug/add-and-commit@v9.1.4

        if: "${{ ! startsWith(github.event.head_commit.message, 'docs: update changelog for ') && steps.semver.outputs.next != '' }}"

        with:

          add: 'CHANGELOG.md'

          commit: --signoff

          default_author: github_actor

          fetch: true

          message: 'docs: update changelog for ${{ steps.semver.outputs.next }}'

          tag: '${{ steps.semver.outputs.next }} --force'

          tag_push: '--force'

name: Push [rebase]

"on":

  push:

    branches:

      - main

concurrency:

  group: push-rebase-main

  cancel-in-progress: true

jobs:

  rebase:

    name: Push [rebase]

    runs-on: ubuntu-latest

    steps:

      - name: Rebase all pull requests on push to the main branch

        uses: peter-evans/rebase@v3.0.0

        with:

          base: main

          exclude-drafts: true

          exclude-labels: |

            no-rebase

            dependencies

        if: "${{ startsWith(github.event.head_commit.message, 'docs: update changelog for ') }}"