Skip to content

Commit 4317e54

Browse files
apirainoUrgau
andauthored
Apply suggestions from code review
Co-authored-by: Urgau <[email protected]>
1 parent 709c5d7 commit 4317e54

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/triagebot/backport.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ When a [regression][regression-beta] for the compiler or the standard library (o
44

55
In order to give more visibility to patches fixing important regressions and facilitate the team taking a decision, a discussion topic on our [Zulip chat][zulip-chat] can be automatically opened ([example][zulip-backport-poll]).
66

7-
The triagebot can be configured to scan every new patch in the git repository and look for a text marker in the opening comment (example "Fixes #123", see [GitHub documentation][gh-assoc-issue-patched]). If such text is found and the issue being fixed is classified as `P-high` or `P-critical` and has a `regression-from-*` label, the triagebot will apply a backport label and open a new Zulip discussion topic.
7+
Automatic nomination of pull requests for backport can be configured to scan every new patch in the git repository and look for a text marker in the opening comment (example "Fixes #123", see [GitHub documentation][gh-assoc-issue-patched]). If such text is found and the issue being fixed is classified as `P-high` or `P-critical` and has one of the `required-issue-label` labels (e.g. `regression-from-*`), the handler will apply the configured `add-labels` labels.
88

99
[regression-beta]: https://github.com/rust-lang/rust/issues?q=is%3Aissue%20label%3Aregression-from-stable-to-beta
1010
[backports]: ../compiler/backports.md#backports
@@ -14,28 +14,28 @@ The triagebot can be configured to scan every new patch in the git repository an
1414

1515
## Configuration
1616

17-
The automatic backport labelling is enabled on a repository when the `triagebot.toml` file is configured with at least one `[backport.<foo>]` table in `triagebot.toml`. There can be multiple occurrence of this configuration to handle different cases:
17+
The automatic backport labelling is enabled on a repository when at least one `[backport.<foo>]` table is configured in `triagebot.toml`:
1818

1919
```toml
2020
[backport.foo]
2121
required-pr-labels = ["T-compiler"]
2222
required-issue-label = "regression-from-stable-to-beta"
23-
add-labels= ["beta-nominated"]
23+
add-labels = ["beta-nominated"]
2424

2525
[backport.bar]
2626
required-pr-labels = ["T-compiler"]
2727
required-issue-label = "regression-from-stable-to-stable"
28-
add-labels= ["beta-nominated", "stable-nominated"]
28+
add-labels = ["beta-nominated", "stable-nominated"]
2929

3030
[backport.baz]
3131
required-pr-labels = ["T-libs", "T-libs-api"]
3232
required-issue-label = "regression-from-stable-to-stable"
33-
add-labels= ["stable-nominated"]
33+
add-labels = ["stable-nominated"]
3434
```
3535

3636
`foo`, `bar`, `baz` are examples of unique identifiers to disambiguate them, they can be anything.
3737

38-
Explaination:
38+
Fields explanation:
3939
- `required-pr-labels`: a list of labels that the pull request must have when it is opened (suggested to use a team label `T-*`)
4040
- `required-issue-label`: a label that the regression must have in order to be identified as such. It can be one of: `regression-from-stable-to-nightly`, `regression-from-stable-to-beta` or `regression-from-stable-to-stable`.
4141
- `add-labels`: a list of labels that the pull request will be assigned, if all conditions apply.

0 commit comments

Comments
 (0)