Merge pull request #220 from Ocramius/feature/logs-badge-matchBranchR…

…egex-documentation Documented `logs.badge.branch` accepting a regular expression
infection · Jul 20, 2021 · 6f2fc1f · 6f2fc1f
2 parents 2787501 + 4e8d383
commit 6f2fc1f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/src/guide/mutation-badge.md b/src/guide/mutation-badge.md
@@ -32,7 +32,20 @@ Take these steps to enable the mutation score badge on your repository:
     {
         "logs": {
             "badge": {
-                "branch": "master"
+                "branch": "/^release-.*$/"
+            }
+        }
+    }
+    ```
+
+    If you provide a value that is not a regular expression starting and ending with `/`, a direct match will
+    be performed:
+
+    ```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"
+            "branch": "/^release-.*$/"
         }
     },
     "tmpDir": "/opt/tmp-folder",