Skip to content

Commit

Permalink
add more config options for no_merges
Browse files Browse the repository at this point in the history
  • Loading branch information
pitaj committed Jul 4, 2023
1 parent ff7da6f commit 38a0daa
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions src/triagebot/no-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,45 @@ This feature is enabled on a repository by having a `[no-merges]` table in `tria
[no-merges]
```

There are three optional values that can be specified in the table:

* `exclude_labels` --- A list of strings of label names to exclude.
PRs with these labels set will not be checked for merge commits.

* `labels` --- A list of strings of label names to add.
These labels will be set on the PR when merge commits are detected.

* `message` --- Override the default message posted for merge commits.
The message will always be followed up with "The following commits are merge commits:" and then a list of the merge commits.

#### Default message

> There are merge commits (commits with multiple parents) in your changes. We have a [no merge policy](https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy) so these commits will need to be removed for this pull request to be merged.
>
> You can start a rebase with the following commands:
>
> ```shell-session
> $ # rebase
> $ git rebase -i master
> $ # delete any merge commits in the editor that appears
> $ git push --force-with-lease
> ```
## Example

```toml
[no_merges]
# PRs with the following labels will be skipped
exclude_labels = ["rollup", "sync"]
# Add the following labels to PRs with merge commits
labels = ["has-merge-commits", "S-waiting-on-author"]
# Post the following warning message as a comment on PRs with merge commits
message = """
This repository does not allow merge commits.
Your PR cannot be merged until it is rebased.
"""
```

## Implementation

See [`src/handlers/no_merges.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/no_merges.rs).

0 comments on commit 38a0daa

Please sign in to comment.