Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention the regex sensitivity of commit_filter strings #385

Merged
merged 1 commit into from
Jun 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,20 @@ Tracks the commits in a [git](http://git-scm.com/) repository.
use this password

* `commit_filter`: *Optional.* Object containing commit message filters
* `commit_filter.exclude`: *Optional.* Array containing strings that should
* `exclude`: *Optional.* Array containing strings that should
cause a commit to be skipped
* `commit_filter.include`: *Optional.* Array continuing strings that
* `include`: *Optional.* Array containing strings that
*MUST* be included in commit messages for the commit to not be
skipped

**Note**: *You must escape any regex sensitive characters, since the string is used as a regex filter.*
For example, using `[skip deploy]` or `[deploy skip]` to skip non-deployment related commits in a deployment pipeline:

```yaml
commit_filter:
exclude: ["\\[skip deploy\\]", "\\[deploy skip\\]"]
```

* `version_depth`: *Optional.* The number of versions to return when performing a check

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