Merge pull request #13 from scribd/helen/SERF-2048/commit-message-check

[SERF-2048] Use shared workflow to check commit message in PR

Author: azclub

.github/workflows/pr-check.yml

@@ -0,0 +1,24 @@
+name: PR Check
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+
+jobs:
+  check-commit-message:
+    name: Check Commit Message
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check Commit Message
+        uses: gsactions/commit-message-checker@v2
+        with:
+          pattern: '^(?:ci|feat|fix|docs|style|refactor|perf|test|chore)\(?(?:\w+|\s|\-|_)?\)?:\s\w+'
+          error: "One or more commit messages do not meet the format requirements. Please check the requirements here: https://github.com/scribd/job-notification#commit-messages"
+          accessToken: ${{ secrets.SCRIBD_GITHUB_RELEASE_TOKEN }}
+          excludeTitle: true
+          excludeDescription: true
+          checkAllCommitMessages: true

README.md

@@ -12,6 +12,7 @@ A GitHub Action for sending job notifications
   - [Overwrite repository link](#overwrite-repository-link)
 - [Development](#development)
   - [Testing](#testing)
+  - [Commit messages](#commit-messages)
 - [Maintainers](#maintainers)
 
 ## Quick Start
@@ -78,6 +79,10 @@ steps:
 
 You can test your changes by pushing them to a branch, which will trigger the [test](.github/workflows/test.yml) workflow to send the notifications to the [test-release-notification](https://scribd.slack.com/archives/C04U68KR6CU) channel on Slack.
 
+### Commit messages
+
+Please follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [Angular commit message guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) for writing commit messages.
+
 ## Maintainers
 
 Made with ❤️ by the Service Foundations teams.