0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-16 21:56:37 -05:00

style(ci/cd): add a commit msg style checker (#796)

https://www.conventionalcommits.org/en/v1.0.0-beta.4/#summary

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Signed-off-by: Ramkumar Chinchani <rchincha@cisco.com>
This commit is contained in:
Ramkumar Chinchani 2022-09-30 16:08:23 -07:00 committed by GitHub
parent 8237f8d20a
commit f658ef66ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

33
.github/workflows/commit-msg.yaml vendored Normal file
View file

@ -0,0 +1,33 @@
name: 'Check commit message style'
on:
pull_request:
types:
- opened
- edited
- reopened
- synchronize
push:
branches:
- main
jobs:
check-commit-message-style:
name: Check commit message style
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Check Commit Type
uses: gsactions/commit-message-checker@v1
with:
pattern: '^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(.+\))?(!)?(: (.*\s*)*))'
flags: 'gm'
error: 'Your first line has to the Conventional Commits specification.'
- name: Check Line Length
uses: gsactions/commit-message-checker@v1
with:
pattern: '^[^#].{74}'
error: 'The maximum line length of 74 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: 'false'