From cd8c01ceb7857002aba501a8f5e90c9007c96070 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Nivon?= Date: Thu, 30 May 2024 00:18:41 +0200 Subject: [PATCH] docs: add precision on config file regarding multi regex per label * docs: correct false statement on basic config regarding label synchronization * docs: typo fix --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4111188..d06fe7a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: