From 4971112df39af7a3007dae8ed209354a2671066e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B8ren=20Louv-Jansen?= Date: Sat, 25 Apr 2020 16:43:04 +0200 Subject: [PATCH] Update docs --- docs/configuration.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index f91176cb..b7f53aed 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -56,7 +56,13 @@ Example: ```json { "upstream": "elastic/kibana", - "branches": [{ "name": "6.x", "checked": true }, "6.3", "6.2", "6.1", "6.0"], + "targetBranchChoices": [ + { "name": "6.x", "checked": true }, + "6.3", + "6.2", + "6.1", + "6.0" + ], "targetPRLabels": ["backport"] } ``` @@ -75,9 +81,9 @@ Config: } ``` -#### `branches` **required** +#### `targetBranchChoices` **required** -List of branches that will be available to backport to. The array can contain branch names as strings or objects that also contains the field `checked` which indicates whether the branch should be pre-selected. It is useful to pre-select branches you often backport to. +List of target branches the user can interactively select. The array can contain branch names as strings or objects that also contains the field `checked` which indicates whether the branch should be pre-selected. It is useful to pre-select branches you often backport to. CLI: `--branch 6.1 --branch 6.0` @@ -85,7 +91,13 @@ Config: ```json { - "branches": [{ "name": "6.x", "checked": true }, "6.3", "6.2", "6.1", "6.0"] + "targetBranchChoices": [ + { "name": "6.x", "checked": true }, + "6.3", + "6.2", + "6.1", + "6.0" + ] } ```