Documented logs.badge.branch used as a regular expression

Also removed `logs.badge.matchBranchRegex` docs: the upstream patch in infection/infection#1538 also got rid of it.
Ocramius · Jul 20, 2021 · 4e8d383 · 4e8d383
1 parent ada9e77
commit 4e8d383
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/src/guide/mutation-badge.md b/src/guide/mutation-badge.md
@@ -32,15 +32,14 @@ Take these steps to enable the mutation score badge on your repository:
     {
         "logs": {
             "badge": {
-                "matchBranchRegex": "/^release-.*$/"
+                "branch": "/^release-.*$/"
             }
         }
     }
     ```
 
-    It is also possible to use `logs.badge.branch`, which does an exact match against your branch, should you wish
-    to run reporting against a single specific branch. Be aware that `branch` and `matchBranchRegex` are mutually 
-    exclusive:
+    If you provide a value that is not a regular expression starting and ending with `/`, a direct match will
+    be performed:
 
     ```json
     {

diff --git a/src/guide/usage.md b/src/guide/usage.md
@@ -27,7 +27,7 @@ The first time you run Infection for your project, it will ask you several quest
         "perMutator": "per-mutator.md",
         "github": true,
         "badge": {
-            "matchBranchRegex": "/^master$/"
+            "branch": "/^release-.*$/"
         }
     },
     "tmpDir": "/opt/tmp-folder",