Skip to content

Commit

Permalink
ci: add commit message check
Browse files Browse the repository at this point in the history
  • Loading branch information
yangkaa authored May 28, 2022
1 parent 4529a8e commit 79a696f
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/commit-message-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 'Commit Message Check'
on:
pull_request:
types:
- opened
- edited
- reopened
- synchronize
push:
branches: [master]

jobs:
check-commit-message:
name: Check Commit Message
runs-on: ubuntu-latest
steps:
- name: Check Commit Type
uses: gsactions/commit-message-checker@v1
with:
pattern: '^\s*(feat|fix|docs|style|refactor|test|ci|perf|revert|chore|to)(\(.+\))?\: .+'
flags: 'gm'
error: 'Your first line has to contain a commit type like "feat: xxx".'
- name: Check Line Length
uses: gsactions/commit-message-checker@v1
with:
pattern: '^.{1,72}$'
error: 'The maximum line length of 72 characters is exceeded.'
excludeDescription: 'true' # optional: this excludes the description body of a pull request
excludeTitle: 'true' # optional: this excludes the title of a pull request
checkAllCommitMessages: 'true' # optional: this checks all commits associated with a pull request
accessToken: ${{ secrets.CHECK_TOKEN }} # github access token is only required if checkAllCommitMessages is true

0 comments on commit 79a696f

Please sign in to comment.