Skip to content

Commit 6b4aba7

Browse files
author
Rui Yang
authored
Merge pull request #385 from jgriff/commit-filter-doc-update
Mention the regex sensitivity of `commit_filter` strings
2 parents 86acbd3 + 5e613de commit 6b4aba7

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,20 @@ Tracks the commits in a [git](http://git-scm.com/) repository.
113113
use this password
114114

115115
* `commit_filter`: *Optional.* Object containing commit message filters
116-
* `commit_filter.exclude`: *Optional.* Array containing strings that should
116+
* `exclude`: *Optional.* Array containing strings that should
117117
cause a commit to be skipped
118-
* `commit_filter.include`: *Optional.* Array continuing strings that
118+
* `include`: *Optional.* Array containing strings that
119119
*MUST* be included in commit messages for the commit to not be
120120
skipped
121121

122+
**Note**: *You must escape any regex sensitive characters, since the string is used as a regex filter.*
123+
For example, using `[skip deploy]` or `[deploy skip]` to skip non-deployment related commits in a deployment pipeline:
124+
125+
```yaml
126+
commit_filter:
127+
exclude: ["\\[skip deploy\\]", "\\[deploy skip\\]"]
128+
```
129+
122130
* `version_depth`: *Optional.* The number of versions to return when performing a check
123131

124132
* `search_remote_refs`: *Optional.* True to search remote refs for the input version when checking out during the get step.

0 commit comments

Comments
 (0)