ci: add pr workflow to check pr title format (#372)

* ci: add pr workflow to check pr title format Signed-off-by: Asra Ali <asraa@google.com>
slsa-framework · Nov 30, 2022 · 128324f · 128324f
1 parent 7bebbb9
commit 128324f
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.github/pr-title-checker-config.json b/.github/pr-title-checker-config.json
@@ -0,0 +1,14 @@
+{
+  "LABEL": {
+    "name": "title needs adjustment",
+    "color": "EEEEEE"
+  },
+  "CHECKS": {
+    "regexp": "^(fix|feat|break|docs|chore|refactor|style|build|ci|revert|test)!?(\\(.*\\))?!?:.*"
+  },
+  "MESSAGES": {
+    "success": "PR title is valid",
+    "failure": "PR title is invalid",
+    "notice": "Title needs to pass regex '^(fix|feat|break|docs|chore|refactor|style|build|ci|revert|test)!?(\\(.*\\))?!?:.*"
+  }
+}
diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml
@@ -0,0 +1,14 @@
+name: PR Title
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: thehanimo/pr-title-checker@e914bff8ab5e6f1a6a270da6954cd6bfd1d7f1fb  # v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          configuration_path: ".github/pr-title-checker-config.json"