chore: add automated changelog functionality

.github/dependabot.yml

@@ -9,7 +9,13 @@ updates:
           update-types:
             - "minor"
             - "patch"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/changelog.yml

@@ -0,0 +1,31 @@
+name: Generate Changelog
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Generate changelog with git-cliff
+        uses: orhun/git-cliff-action@4d0efd7c7a4b55484abf71c29a29712192adebdb
+        with:
+          config: cliff.toml
+          args: --verbose
+
+      - name: Upload artifacts
+        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
+        with:
+          body_path: CHANGELOG.md
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [4.0.0] - 2025-01-15
+
+### Changed
+- Updated Ruby support to 3.3+
+- Updated dependencies
+- Various CI/CD updates
+
+### Added
+- Ruby 4.0 support in CI matrix
+
+## [3.0.0] - 2024-06-30
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v3.0.0) for details.
+
+## [2.0.1] - 2024-01-10
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v2.0.1) for details.
+
+## [2.0.0] - 2023-06-15
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v2.0.0) for details.
+
+## [1.2.1] - 2023-01-20
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v1.2.1) for details.
+
+## [1.2.0] - 2022-12-10
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v1.2.0) for details.
+
+## [1.1.1] - 2022-06-15
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v1.1.1) for details.
+
+## [1.1.0] - 2022-03-01
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v1.1.0) for details.
+
+## [1.0.0] - 2021-09-20
+
+See [GitHub Releases](https://github.com/technicalpanda/awrence/releases/tag/v1.0.0) for details.
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,64 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+
+All notable changes to this project will be documented in this file.
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [Unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}🚨 {% endif %}{{ commit.message | upper_first }} ([`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/technicalpanda/awrence/commit/{{ commit.id }}))
+    {%- endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for parsing the commit messages
+commit_parsers = [
+    { message = "^feat", group = "Features" },
+    { message = "^fix", group = "Bug Fixes" },
+    { message = "^doc", group = "Documentation" },
+    { message = "^perf", group = "Performance" },
+    { message = "^refactor", group = "Refactoring" },
+    { message = "^test", group = "Testing" },
+    { message = "^ci", group = "CI/CD" },
+    { message = "^chore", skip = true },
+    { message = "^Bump", group = "Dependencies" },
+    { message = ".*", group = "Other" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = true
+# filter commits by commit scope
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "v?[0-9].*"
+# regex for skipping tags
+skip_tags = ""
+# limit commits displayed on release notes (0 = unlimited)
+limit_commits = 0
+# sorting of commits inside sections
+sort_commits = "oldest"