ci: Fix release process to find breaking changes (#3021)

felixwang9817 · adchia · commit 8a0dd4c30462 · 2022-08-09T23:09:10.000-04:00
* Fix release process to find breaking changes

Signed-off-by: Felix Wang &lt;wangfelix98@gmail.com&gt;

* Add comments

Signed-off-by: Felix Wang &lt;wangfelix98@gmail.com&gt;
diff --git a/.releaserc.js b/.releaserc.js
@@ -28,7 +28,12 @@ module.exports = {
             "releaseRules": [
                 {breaking: true, release: 'minor'},
                 {tag: 'Breaking', release: 'minor'},
-            ]
+                {type: '*!', release: 'minor'},
+            ],
+            // Ensure that the "BREAKING CHANGE" notes in commit footers are parsed
+            "parserOpts": {
+                "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+            }
         }],
 
         ["@semantic-release/exec", {
@@ -39,7 +44,10 @@ module.exports = {
             "prepareCmd": "python ./infra/scripts/release/bump_file_versions.py ${lastRelease.version} ${nextRelease.version}"
         }],
 
-        "@semantic-release/release-notes-generator",
+        ["@semantic-release/release-notes-generator", {
+            // Ensure that a "Breaking Changes" section is added to the release notes
+            "preset": "angular"
+        }],
 
         // Update the changelog
         [
