Add release note generation to CI

Author: mathieucarbou

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build-arduino:
+  arduino:
     name: ${{ matrix.config }}
     runs-on: ubuntu-latest
     strategy:
@@ -82,3 +82,31 @@ jobs:
           pip install --upgrade platformio
 
       - run: PLATFORMIO_SRC_DIR=examples/Client PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }}
+
+  release:
+    name: Release
+    if: ${{ github.repository_owner == 'ESP32Async' && github.event_name != 'pull_request' && startsWith(github.ref, 'refs/tags/v') }}
+    runs-on: ubuntu-latest
+    needs: [arduino, platformio]
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Changelog
+        id: github_release
+        uses: mikepenz/release-changelog-builder-action@v5
+        with:
+          failOnError: true
+          commitMode: true
+          configuration: ".github/workflows/release-notes-config.json"
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body: ${{steps.github_release.outputs.changelog}}
+          append_body: true
+          make_latest: true
+          draft: false
+          prerelease: false

.github/workflows/release-notes-config.json

@@ -0,0 +1,50 @@
+{
+    "categories": [
+        {
+            "title": "## ⚡ Breaking Changes",
+            "labels": [
+                "break"
+            ]
+        },
+        {
+            "title": "## 🚀 Features",
+            "labels": [
+                "feat"
+            ]
+        },
+        {
+            "title": "## 🐛 Fixes",
+            "labels": [
+                "fix"
+            ]
+        },
+        {
+            "title": "## 📚 Documentation",
+            "labels": [
+                "doc"
+            ]
+        },
+        {
+            "title": "## 🛠 Under the hood",
+            "labels": []
+        }
+    ],
+    "template": "${{CHANGELOG}}",
+    "pr_template": "- [${{TITLE}}](https://github.com/mathieucarbou/${{REPO}}/commit/${{MERGE_SHA}})",
+    "empty_template": "- no changes",
+    "label_extractor": [
+        {
+            "pattern": "(.): (.+)",
+            "target": "$1",
+            "on_property": "title"
+        },
+        {
+            "pattern": "(.) (.+)",
+            "target": "$1",
+            "on_property": "title"
+        }
+    ],
+    "tag_resolver": {
+        "method": "semver"
+    }
+}