ci: fix permissions for release workflow & style changelog

LironEr · Apr 11, 2024 · 1e1d16c · 1e1d16c
1 parent 75bfbc9
commit 1e1d16c
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 2 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,7 +4,9 @@ on:
   workflow_dispatch:
 
 permissions:
-  contents: write
+  contents: write # to be able to publish a GitHub release
+  issues: write # to be able to comment on released issues
+  pull-requests: write # to be able to comment on released pull requests
 
 jobs:
   release:

diff --git a/.releaserc b/.releaserc
@@ -19,7 +19,52 @@
         ]
       }
     ],
-    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "parserOpts": {
+          "noteKeywords": [
+            "BREAKING CHANGE",
+            "BREAKING CHANGES",
+            "BREAKING"
+          ]
+        },
+        "presetConfig": {
+          "types": [
+            {
+              "type": "breaking",
+              "section": "❗ BREAKING CHANGES ❗",
+              "hidden": false
+            },
+            {
+              "type": "feat",
+              "section": "✨ Features",
+              "hidden": false
+            },
+            {
+              "type": "fix",
+              "section": "🐛 Fixes",
+              "hidden": false
+            },
+            {
+              "type": "chore",
+              "section": "🔨  Misc.",
+              "hidden": false
+            },
+            {
+              "type": "docs",
+              "section": "📝  Documentation",
+              "hidden": false
+            },
+            {
+              "type": "refactor",
+              "section": "⚡️ Refactor",
+              "hidden": false
+            }
+          ]
+        }
+      }
+    ],
     "@semantic-release/github",
     "semantic-release-major-tag"
   ]