Skip to content

Commit

Permalink
add more config options for no_merges
Browse files Browse the repository at this point in the history
- option for excluding PRs with certain labels
- option for setting labels when merge commits are detected
- option for setting a custom comment message
  • Loading branch information
pitaj committed Jun 14, 2023
1 parent b96677b commit ee91f28
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 15 deletions.
12 changes: 11 additions & 1 deletion src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,18 @@ pub(crate) struct AssignConfig {

#[derive(PartialEq, Eq, Debug, serde::Deserialize)]
pub(crate) struct NoMergesConfig {
/// No action will be taken on PRs with these labels.
#[serde(default)]
_empty: (),
pub(crate) exclude_labels: Vec<String>,
/// Set these labels on the PR when merge commits are detected.
#[serde(default)]
pub(crate) labels: Vec<String>,
/// Override the default message to post when merge commits are detected.
///
/// This message will always be followed up with
/// "The following commits are merge commits:" and then
/// a list of the merge commits.
pub(crate) message: Option<String>,
}

#[derive(PartialEq, Eq, Debug, serde::Deserialize)]
Expand Down
58 changes: 44 additions & 14 deletions src/handlers/no_merges.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
use crate::{
config::NoMergesConfig,
db::issue_data::IssueData,
github::{IssuesAction, IssuesEvent},
github::{IssuesAction, IssuesEvent, Label},
handlers::Context,
};
use anyhow::Context as _;
Expand Down Expand Up @@ -38,16 +38,23 @@ pub(super) async fn parse_input(
return Ok(None);
}

// Require an empty configuration block to enable no-merges notifications.
if config.is_none() {
// Require a `[no_merges]` configuration block to enable no-merges notifications.
let Some(config) = config else {
return Ok(None);
}
};

// Don't ping on rollups or draft PRs.
if event.issue.title.starts_with("Rollup of") || event.issue.draft {
return Ok(None);
}

// Don't trigger if the PR has any of the excluded labels.
for label in event.issue.labels() {
if config.exclude_labels.contains(&label.name) {
return Ok(None);
}
}

let mut merge_commits = HashSet::new();
let commits = event
.issue
Expand All @@ -73,22 +80,17 @@ pub(super) async fn parse_input(

pub(super) async fn handle_input(
ctx: &Context,
_config: &NoMergesConfig,
config: &NoMergesConfig,
event: &IssuesEvent,
input: NoMergesInput,
) -> anyhow::Result<()> {
let mut client = ctx.db.get().await;
let mut state: IssueData<'_, NoMergesState> =
IssueData::load(&mut client, &event.issue, NO_MERGES_KEY).await?;

let since_last_posted = if state.data.mentioned_merge_commits.is_empty() {
""
let mut message = if let Some(ref message) = config.message {
message.clone()
} else {
" (since this message was last posted)"
};

let mut should_send = false;
let mut message = format!(
"
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
Expand All @@ -102,11 +104,25 @@ pub(super) async fn handle_input(
$ # delete any merge commits in the editor that appears
$ git push --force-with-lease
```
"
.to_string()
};

let since_last_posted = if state.data.mentioned_merge_commits.is_empty() {
""
} else {
" (since this message was last posted)"
};
write!(
message,
"
The following commits are merge commits{since_last_posted}:
"
)
.unwrap();

"
);
let mut should_send = false;
for commit in &input.merge_commits {
if state.data.mentioned_merge_commits.contains(commit) {
continue;
Expand All @@ -118,6 +134,20 @@ pub(super) async fn handle_input(
}

if should_send {
// Set labels
let labels = config
.labels
.iter()
.cloned()
.map(|name| Label { name })
.collect();
event
.issue
.add_labels(&ctx.github, labels)
.await
.context("failed to set no_merges labels")?;

// Post comment
event
.issue
.post_comment(&ctx.github, &message)
Expand Down

0 comments on commit ee91f28

Please sign in to comment.