ci: Add commit name linter for PRs (#35)

* Add commit name linter * Goodbye angular
cornellev · Dec 9, 2024 · d58e467 · d58e467
1 parent 47f1570
commit d58e467
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/.github/workflows/docs.yml → .github/workflows/docs.yaml b/.github/workflows/docs.yml → .github/workflows/docs.yaml
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -0,0 +1,18 @@
+# https://github.com/satellytes/commitlint-pr-title
+name: PR Style
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+    branches: [main]
+
+jobs:
+  title-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: manually install any commitlint presets that we extend from
+        run: npm install --no-save @commitlint/config-conventional
+
+      - uses: satellytes/commitlint-pr-title@v1
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,9 @@
+module.exports = {
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      ['chore', 'ci', 'docs', 'feat', 'fix', 'refactor', 'revert', 'test']
+    ],
+  }
+};