Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sorenlouv committed Apr 25, 2020
1 parent 9e04557 commit 4971112
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
```
Expand All @@ -75,17 +81,23 @@ 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`

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"
]
}
```

Expand Down

0 comments on commit 4971112

Please sign in to comment.