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.

Sign up for GitHub

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

docs: add precision on config file regarding multi regex per label #85

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add precision on config file regarding multi regex per label #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Issue labeler will label issues based on the body content of the issue.

Create a `.github/labeler.yml` file with a list of labels and regex to match to apply the label.

The key is the name of the label in your repository that you want to add (eg: "merge conflict", "needs-updating") and the value is the regular expression for when to apply the label. Should the regular expression not match, the label will be removed.
The key is the name of the label in your repository that you want to add (eg: "merge conflict", "needs-updating") and the value is the regular expression for when to apply the label. By default, labels that no longer match are not removed from the issue (see `sync-labels`).

⚠️ If you provide more than one regex per label, we require all of them to match for the label to be applied. ⚠️

#### Basic Examples

Expand Down Expand Up @@ -165,8 +167,7 @@ jobs:

### Syncing Labels

By default, labels that no longer match are not removed from the issue. To enable this functionality, explicity
set `sync-labels` to `1`.
By default, labels that no longer match are not removed from the issue. To enable this functionality, explicitly set `sync-labels` to `1`.

```yml
jobs:
Expand Down