From 4e8d3836253f57ca867331d4d766b7c886fa80fb Mon Sep 17 00:00:00 2001 From: Marco Pivetta Date: Tue, 20 Jul 2021 13:24:02 +0200 Subject: [PATCH] Documented `logs.badge.branch` used as a regular expression Also removed `logs.badge.matchBranchRegex` docs: the upstream patch in https://github.com/infection/infection/pull/1538 also got rid of it. --- src/guide/mutation-badge.md | 7 +++---- src/guide/usage.md | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/guide/mutation-badge.md b/src/guide/mutation-badge.md index e669549f..6f9fcfeb 100644 --- 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 index 0708a336..8716092c 100644 --- 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",