chore: stricter commitlint checks for pr merge

Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>

.github/workflows/pr-commitlint.yml

@@ -21,5 +21,14 @@ jobs:
           if [ ! ${{ github.ref }} = "refs/heads/staging" ]; then
             first_commit=${{ github.event.pull_request.base.sha }}
             last_commit=${{ github.event.pull_request.head.sha }}
+            # Ensure code-review commits don't get merged
+            sed "s/code-review-rule': \[0/code-review-rule': [2/g" -i commitlint.config.js
             npx commitlint --from $first_commit --to $last_commit -V
+
+            git log --pretty=format:%s $first_commit..$last_commit > ./subjects
+            duplicates="$(cat ./subjects | sort | uniq -D)"
+            if [ "$duplicates" != "" ]; then
+              echo -e "Duplicate commits found:\n$duplicates" >&2
+              exit 1
+            fi
           fi

commitlint.config.js

@@ -2,10 +2,25 @@ module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
     'type-enum': [2, 'always', ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test', 'example']],
+    'code-review-rule': [0, 'always'],
   },
   defaultIgnores: false,
   ignores: [
-    (message) => message.startsWith('chore(bors): merge pull request #'),
-    (message) => message.startsWith('Merge #')
-  ]
+      (message) => message.startsWith('chore(bors): merge pull request #'),
+      (message) => message.startsWith('Merge #')
+  ],
+  plugins: [
+    {
+      rules: {
+        'code-review-rule': ({subject}) => {
+          const REVIEW_COMMENTS = `Please don't merge code-review commits, instead squash them in the parent commit`;
+          if (subject.includes('code-review')) return [ false, REVIEW_COMMENTS ];
+          if (subject.includes('review comment')) return [ false, REVIEW_COMMENTS ];
+          if (subject.includes('address comment')) return [ false, REVIEW_COMMENTS ];
+          if (subject.includes('addressed comment')) return [ false, REVIEW_COMMENTS ];
+          return [ true ];
+        },
+      },
+    },
+  ],
 }