🔖(obsidian) Generate release notes with git-cliff

Author: tchlyah

.github/workflows/release.yml

@@ -11,14 +11,15 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+      pull-requests: read
 
     steps:
       - uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 22
           cache: npm
@@ -48,13 +49,23 @@ jobs:
       - name: Verify release artifact
         run: npm run verify:release
 
+      - name: Generate changelog
+        id: git-cliff
+        uses: orhun/git-cliff-action@v4
+        with:
+          config: cliff.toml
+          args: --latest --strip header
+        env:
+          OUTPUT: CHANGES.md
+          GITHUB_REPO: ${{ github.repository }}
+
       - name: Publish GitHub release
         uses: ncipollo/release-action@v1.21.0
         with:
           allowUpdates: true
           artifactErrorsFailBuild: true
           artifacts: "manifest.json,dist/main.js,dist/styles.css"
-          generateReleaseNotes: true
+          body: ${{ steps.git-cliff.outputs.content }}
           makeLatest: true
           name: ${{ github.ref_name }}
           tag: ${{ github.ref_name }}

.github/workflows/validate.yml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/checkout@v6
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 22
           cache: npm

README.md

@@ -35,5 +35,5 @@ This plugin renders fenced code blocks like:
 
 - CI runs on pushes to `main` and on pull requests via `.github/workflows/validate.yml`.
 - Releases run from exact version tags like `0.1.0`, not `v0.1.0`.
-- The release workflow verifies the tag matches both `package.json` and `manifest.json`, builds the plugin, and uploads `manifest.json`, `main.js`, and `styles.css` to the GitHub release.
+- The release workflow verifies the tag matches both `package.json` and `manifest.json`, builds the plugin, generates notes with `git-cliff`, and uploads `manifest.json`, `main.js`, and `styles.css` to the GitHub release.
 - Before creating a release tag locally, update the package version with `npm version <patch|minor|major>`, then push the commit and the matching tag.

cliff.toml

@@ -0,0 +1,54 @@
+[changelog]
+body = """
+{% for group, commits in commits | group_by(attribute="group") %}
+### {{ group }}
+
+{% for commit in commits %}
+{%- set title = commit.message | split(pat="\n") | first | trim | split(pat=" (#") | first -%}
+{%- if commit.scope -%}
+{%- set clean_title = title | split(pat="(" ~ commit.scope ~ ")") | last | trim | trim_start_matches(pat=":") | trim -%}
+- [`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/couchbaselabs/obsidian-couchbase-topology/commit/{{ commit.id }}) - **{{ commit.scope }}**: {{ clean_title }}{% if commit.remote.pr_number and commit.remote.username %} *(PR [#{{ commit.remote.pr_number }}](https://github.com/couchbaselabs/obsidian-couchbase-topology/pull/{{ commit.remote.pr_number }}) by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}))*{% elif commit.remote.username %} *(commit by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}))*{% elif commit.author.name %} *(commit by {{ commit.author.name }})*{% endif %}
+{% else %}
+{%- set first_token = title | split(pat=" ") | first -%}
+{%- set clean_title = title | replace(from=first_token ~ " ", to="") -%}
+- [`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/couchbaselabs/obsidian-couchbase-topology/commit/{{ commit.id }}) - {{ clean_title }}{% if commit.remote.pr_number and commit.remote.username %} *(PR [#{{ commit.remote.pr_number }}](https://github.com/couchbaselabs/obsidian-couchbase-topology/pull/{{ commit.remote.pr_number }}) by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}))*{% elif commit.remote.username %} *(commit by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}))*{% elif commit.author.name %} *(commit by {{ commit.author.name }})*{% endif %}
+{%- endif %}
+{% endfor %}
+{% endfor %}
+"""
+
+trim = true
+
+[git]
+conventional_commits = false
+filter_unconventional = false
+filter_commits = true
+tag_pattern = "[0-9]+\\.[0-9]+\\.[0-9]+"
+sort_commits = "oldest"
+commit_preprocessors = [
+  { pattern = '^(💥|✨️|✨|🎉|🌱|🚩|🥚|👔|🌐|✈️|🦖|🐛|🚑️|🩹|🥅|⚡️|🧵|🔒️|🔒|🔐|🛂|🦺|✅|🧪|🤡|🧐|⚗️|🚨|♻️|🔥|🗑️|⚰️|💩|⏪️|📝|✏️|💬|💡|📄|👥|🔍️|🎨|💄|♿️|🚸|📱|💫|🍱|📸|⬆️|⬆|⬇️|⬇|➕|➖|📌|👽️|👷|🚀|🔧|🔨|🚚|📦️|📦|🧱|🩺|💚|🔀|🙈|💸|🧑‍💻|🐳️|🐳|🏗️|🗃️|📈|🏷️|🔊|🔇|🔖|🚧|🍻)([^\s(])', replace = "$1 $2" },
+  { pattern = ' ️', replace = '' },
+  { pattern = '^(\S+\)):\s*', replace = "$1 " },
+  { pattern = '^(\S+) #[0-9]+:\s*', replace = "$1 " },
+]
+
+commit_parsers = [
+  { message = "^(?:💥)(?:\\(([^)]+)\\))?", group = "💥 Breaking Changes", scope = "${1}" },
+  { message = "^(?:✨️|✨)\\s+fix\\(([^)]+)\\)", group = "🐛 Bug Fixes", scope = "${1}" },
+  { message = "^(?:✨|✨️|🎉|🌱|🚩|🥚|👔|🌐|✈️|🦖)(?:\\(([^)]+)\\))?", group = "✨ New Features", scope = "${1}" },
+  { message = "^(?:🐛|🚑️|🩹|🥅)(?:\\(([^)]+)\\))?", group = "🐛 Bug Fixes", scope = "${1}" },
+  { message = "^(?:⚡️|🧵)(?:\\(([^)]+)\\))?", group = "⚡️ Performance", scope = "${1}" },
+  { message = "^(?:🔒|🔒️|🔐|🛂|🦺)(?:\\(([^)]+)\\))?", group = "🔒 Security", scope = "${1}" },
+  { message = "^(?:✅|🧪|🤡|🧐|⚗️|🚨)(?:\\(([^)]+)\\))?", group = "🧪 Tests & Quality", scope = "${1}" },
+  { message = "^(?:♻️|🔥|🗑️|⚰️|💩|⏪️)(?:\\(([^)]+)\\))?", group = "♻️ Refactors & Cleanup", scope = "${1}" },
+  { message = "^(?:📝|✏️|💬|💡|📄|👥|🔍️)(?:\\(([^)]+)\\))?", group = "📝 Documentation & Content", scope = "${1}" },
+  { message = "^(?:🎨|💄|♿️|🚸|📱|💫|🍱|📸)(?:\\(([^)]+)\\))?", group = "🎨 UI/UX & Accessibility", scope = "${1}" },
+  { message = "^(?:⬆|⬇|⬆️|⬇️|➕|➖|📌|👽️)(?:\\(([^)]+)\\))?", group = "📦 Dependencies", scope = "${1}" },
+  { message = "^(?:👷|🚀|🔧|🔨|🚚|📦|📦️|🧱|🩺|💚|🔀|🙈|💸|🧑‍💻|🐳|🐳️)(?:\\(([^)]+)\\))?", group = "🔧 Infrastructure & DevOps", scope = "${1}" },
+  { message = "^(?:🏗️|🗃️|📈|🏷️)(?:\\(([^)]+)\\))?", group = "🏗️ Architecture & Data", scope = "${1}" },
+  { message = "^(?:🔊|🔇)(?:\\(([^)]+)\\))?", group = "🔊 Logging", scope = "${1}" },
+  { message = "^(?:🔖)(?:\\(([^)]+)\\))?", group = "🔖 Release & Versioning", scope = "${1}" },
+  { message = "^(?:🚧)(?:\\(([^)]+)\\))?", group = "🚧 Work In Progress", scope = "${1}" },
+  { message = "^(?:🍻)(?:\\(([^)]+)\\))?", group = "🍻 Miscellaneous", scope = "${1}" },
+  { message = ".*", group = "🔹 Other Changes" },
+]