Skip to content

Commit 171c827

Browse files
authored
Update README.md
1 parent b83d83f commit 171c827

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GS Commit Message Checker
1+
# Commit Messages(in Pull Reqeust) Checker with regex
22

33
![Version](https://img.shields.io/github/v/release/gsactions/commit-message-checker?style=flat-square)
44
![Test](https://github.com/gsactions/commit-message-checker/workflows/build-test/badge.svg)
@@ -32,32 +32,50 @@ on:
3232
- edited
3333
- reopened
3434
- synchronize
35-
push:
36-
branches:
37-
- master
38-
- 'releases/*'
3935

4036
jobs:
4137
check-commit-message:
4238
name: Check Commit Message
4339
runs-on: ubuntu-latest
4440
steps:
45-
- name: Check Commit Type
46-
uses: gsactions/commit-message-checker@v1
41+
- name: Get PR Commits
42+
id: 'get-pr-commits'
43+
uses: tim-actions/get-pr-commits@master
4744
with:
48-
pattern: '\[[^]]+\] .+$'
49-
flags: 'gm'
50-
error: 'Your first line has to contain a commit type like "[BUGFIX]".'
51-
- name: Check Line Length
52-
uses: gsactions/commit-message-checker@v1
45+
token: ${{ secrets.GITHUB_TOKEN }}
46+
47+
- name: Check Subject Line Length
48+
uses: tim-actions/[email protected]
49+
with:
50+
commits: ${{ steps.get-pr-commits.outputs.commits }}
51+
pattern: '^.{0,75}(\n.*)*$'
52+
error: 'Subject too long (max 75)'
53+
54+
- name: Check Body Line Length
55+
if: ${{ success() || failure() }}
56+
uses: tim-actions/[email protected]
57+
with:
58+
commits: ${{ steps.get-pr-commits.outputs.commits }}
59+
pattern: '^.+(\n.{0,72})*$'
60+
error: 'Body line too long (max 72)'
61+
62+
- name: Check Fixes
63+
if: ${{ success() || failure() }}
64+
uses: tim-actions/[email protected]
5365
with:
54-
pattern: '^[^#].{74}'
55-
error: 'The maximum line length of 74 characters is exceeded.'
56-
- name: Check for Resolves / Fixes
57-
uses: gsactions/commit-message-checker@v1
66+
commits: ${{ steps.get-pr-commits.outputs.commits }}
67+
pattern: '\s*Fixes\s*:?\s*(#\d+|github\.com\/kata-containers\/[a-z-.]*#\d+)'
68+
error: 'No "Fixes" found'
69+
70+
- name: Check subsystem
71+
if: ${{ success() || failure() }}
72+
uses: tim-actions/[email protected]
5873
with:
59-
pattern: '^.+(Resolves|Fixes): \#[0-9]+$'
60-
error: 'You need at least one "Resolves|Fixes: #<issue number>" line.'
74+
commits: ${{ steps.get-pr-commits.outputs.commits }}
75+
pattern: '^[\h]*([^:\h]+)[\h]*:'
76+
error: 'Failed to find subsystem in subject'
77+
78+
6179
```
6280

6381
## Development

0 commit comments

Comments
 (0)