Skip to content

Commit

Permalink
Improve wording (#17)
Browse files Browse the repository at this point in the history
Don't use word "behaviour" as it is clear that it is a behaviour.

Use verb "Filter" as prefix (not noun "filtering" as postfix) to comply
with other behaviours (e.g. "Filter by name..." from scm-api-plugin).

Use word "pattern" (not "tag") as users may be confused because git
itself uses tags.

Quote the patterns to make clear that "[" and "]" have to be contained
literally and are not just used as delimiters in the help itself.
  • Loading branch information
darxriggs authored and witokondoria committed Feb 5, 2019
1 parent ca99c5b commit 0d3c0e7
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 10 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Commit skip SCM filters

This repo is a collection of traits for several SCM Jenkins plugins.
This repository contains a collection of traits for several branch-source Jenkins plugins.

It provides filters for
- GitHub: Filtering pull requests
- GitHub: Filtering pull requests
- Bitbucket: Filtering pull requests


The filtering will be performed matching the last commit message, applying it whether it contains the tags [skip ci] or [ci skip]. The check is case-insensitive.
The filtering will be performed matching the last commit message, applying it whether it contains the patterns "[skip ci]" or "[ci skip]". The check is case-insensitive.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ abstract static class BranchCommitSkipTraitDescriptorImpl extends SCMSourceTrait

@Override
public String getDisplayName() {
return "Commit message filtering behaviour (branches)";
return "Filter branches by commit message";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ abstract static class CommitSkipTraitDescriptorImpl extends SCMSourceTraitDescri

@Override
public String getDisplayName() {
return "Commit message filtering behaviour (pull requests)";
return "Filter pull requests by commit message";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div>
Defines whether a branch should be excluded. Will be so if the last commit contains the tags [ci skip] or [skip ci] (case insensitive).
</div>
Branches whose last commit's message contains (case insensitive) the pattern "[ci skip]" or "[skip ci]" will be ignored.
</div>
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div>
Defines whether a pull request creation or sync should be excluded. Will be so if the last commit contains the tags [ci skip] or [skip ci] (case insensitive).
</div>
Pull requests whose last commit's message contains (case insensitive) the pattern "[ci skip]" or "[skip ci]" will be ignored.
</div>

0 comments on commit 0d3c0e7

Please sign in to comment.