Skip to content

Commit 15924ee

Browse files
authored
docs: update README to document commitMessageRegexPattern option (#179)
1 parent bb906db commit 15924ee

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ changelog:
6666

6767
```
6868
* `convention`
69+
* `commitMessageRegexPattern` custom regex pattern for commit messages
70+
* the default regex pattern for Conventional Commit format is `^(?<type>\w+)(?:\((?<scope>[^()]+)\))?(?<breaking>!)?:\s*(?<description>.+)`
71+
* need to use add to this pattern (beginning or end) if you want to keep following the Conventional Commit format
6972
* `commitTypes` an array of expected commit types
7073
* show warnings for unexpected types
7174
* if not set or empty commit type validation is disabled
@@ -77,8 +80,6 @@ changelog:
7780
* `releaseTagGlobPattern` glob pattern to filter for release tags
7881
* release tags must contain semantic version (`[0-9]+\.[0-9]+\.[0-9]+`)
7982
* default `*`
80-
* `issueRegexPattern` regex pattern to find issue IDs
81-
* e.g. Jira issue pattern `[A-Z]{3,}-\\d+`
8283

8384
* `changelog`
8485
* `commitTypes` filter commits by type
@@ -107,6 +108,8 @@ changelog:
107108
* `%issue%` issue id placeholder
108109
* eg `https://jira.example.org/browse/%issue%`
109110
* if not set or empty link generation is disabled
111+
* `issueRegexPattern` regex pattern to find issue IDs
112+
* e.g. Jira issue pattern `[A-Z]{3,}-\\d+`
110113

111114

112115
### Automatically Validate Commit Message Convention before Commit

0 commit comments

Comments
 (0)