Skip to content

Commit f215e92

Browse files
authored
README.md: update versions, fix typos
Currently, the example uses `@v.0.1.0` version of this package, and `@master` of get-pr-commits. This is obviously wrong, since v.0.1.0 is not working with the parameters in the example. Fix the example using last released versions, and fix some typos while we're at it.
1 parent d6d9770 commit f215e92

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Commit Messages(in Pull Reqeust) Checker with regex
1+
# Commit Messages (in Pull Request) 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)
55

6-
A GitHub action that checks that commit messages match a regex patter. The
6+
A GitHub action that checks that commit messages match a regex pattern. The
77
action is able to act on pull request and push events and check the pull
88
request title and body or the commit message of the commits of a push.
99

1010
On pull requests the title and body are concatenated delimited by two line
1111
breaks.
1212

13-
Designed to be very flexible in usage you can split checks into various
13+
Designed to be very flexible in usage: you can split checks into various
1414
workflows, using action types on pull request to listen on, define branches
1515
for pushes etc. etc.
1616

@@ -45,23 +45,23 @@ jobs:
4545
token: ${{ secrets.GITHUB_TOKEN }}
4646

4747
- name: Check Subject Line Length
48-
uses: tim-actions/commit-message-checker-with-regex@v0.1.0
48+
uses: tim-actions/commit-message-checker-with-regex@v1.0.0
4949
with:
5050
commits: ${{ steps.get-pr-commits.outputs.commits }}
5151
pattern: '^.{0,75}(\n.*)*$'
5252
error: 'Subject too long (max 75)'
5353

5454
- name: Check Body Line Length
5555
if: ${{ success() || failure() }}
56-
uses: tim-actions/commit-message-checker-with-regex@v0.1.0
56+
uses: tim-actions/commit-message-checker-with-regex@v0.3.1
5757
with:
5858
commits: ${{ steps.get-pr-commits.outputs.commits }}
5959
pattern: '^.+(\n.{0,72})*$'
6060
error: 'Body line too long (max 72)'
6161

6262
- name: Check Fixes
6363
if: ${{ success() || failure() }}
64-
uses: tim-actions/commit-message-checker-with-regex@v0.1.0
64+
uses: tim-actions/commit-message-checker-with-regex@v0.3.1
6565
with:
6666
commits: ${{ steps.get-pr-commits.outputs.commits }}
6767
pattern: '\s*Fixes\s*:?\s*(#\d+|github\.com\/kata-containers\/[a-z-.]*#\d+)'
@@ -70,7 +70,7 @@ jobs:
7070

7171
- name: Check subsystem
7272
if: ${{ success() || failure() }}
73-
uses: tim-actions/commit-message-checker-with-regex@v0.1.0
73+
uses: tim-actions/commit-message-checker-with-regex@v0.3.1
7474
with:
7575
commits: ${{ steps.get-pr-commits.outputs.commits }}
7676
pattern: '^[\h]*([^:\h\n]+)[\h]*:'

0 commit comments

Comments
 (0)