Documented logs.badge.matchBranchRegex

Replaced `logs.badge.branch` with `logs.badge.matchBranchRegex` in examples, since it is much more powerful, and probably a better long-term solution to more complex scenarios.
Ocramius · Jul 14, 2021 · ada9e77 · ada9e77
1 parent 2787501
commit ada9e77
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/src/guide/mutation-badge.md b/src/guide/mutation-badge.md
@@ -32,7 +32,21 @@ Take these steps to enable the mutation score badge on your repository:
     {
         "logs": {
             "badge": {
-                "branch": "master"
+                "matchBranchRegex": "/^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:
+
+    ```json
+    {
+        "logs": {
+            "badge": {
+                "branch": "main"
             }
         }
     }

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": {
-            "branch": "master"
+            "matchBranchRegex": "/^master$/"
         }
     },
     "tmpDir": "/opt/tmp-folder",