Skip to content

Commit 0e4ffa6

Browse files
committed
update the README
1 parent effb8ee commit 0e4ffa6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

setup-files/Gerald-README.md

+5
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ These files support typical [glob functionality](https://www.npmjs.com/package/f
3434
In addition to glob patterns, Gerald rules also support Regular Expressions. Regular Expressions will be tested against the `diff` of a file. Regular Expressions should be surrounded with double quotes.
3535
`"/^find me!$/ig" @<username or Organization/team-slug>`
3636

37+
### Labels
38+
39+
Your file and diff patterns can be prepended with a label. When that happens, the label is included in the notification that is added in the pull request. This makes it easier to understand why you have been notified (or added as a reviewer) to a PR.
40+
`mylabel: "/^find me!$/ig" @<username or Organization/team-slug>`
41+
3742
## On Pull Request vs. On Push Without Pull Request
3843

3944
In `.github/REVIEWERS`, all rules are run when a pull request is created, because only pull requests can have reviewers. In `.github/NOTIFIED`, rules under the `[ON PULL REQUEST]` section will be run when a pull request is made. Rules under the `[ON PUSH WITHOUT PULL REQUEST]` section will be run whenever someone pushes directly to a list of protected branches. By default, that list is `master`, `main`, and `develop`.

0 commit comments

Comments
 (0)