Merge pull request #525 from Kobzol/ignore-blocks

Implement homu-compatible ignore blocks

Author: Kobzol

src/bors/merge_queue.rs

@@ -1251,4 +1251,47 @@ auto_build_failed = ["+foo", "+bar", "-baz"]
         })
         .await;
     }
+
+    #[sqlx::test]
+    async fn commit_message_skip_ignore_block(pool: sqlx::PgPool) {
+        run_test(pool, async |ctx: &mut BorsTester| {
+            ctx.edit_pr((), |pr| {
+                pr.description = r"This is a very good PR.
+
+<!-- homu-ignore:start -->
+ignore this 1
+<!-- homu-ignore:end -->
+
+include this
+
+<!-- homu-ignore:start -->
+ignore this 2
+<!-- homu-ignore:end -->
+
+also include this pls"
+                    .to_string();
+            })
+            .await?;
+
+            ctx.approve(()).await?;
+            ctx.start_and_finish_auto_build(()).await?;
+
+            insta::assert_snapshot!(ctx.auto_branch().get_commit().message(), @r"
+            Auto merge of #1 - pr-1, r=default-user
+            Title of PR 1
+
+            This is a very good PR.
+
+
+
+            include this
+
+
+
+            also include this pls
+            ");
+            Ok(())
+        })
+        .await;
+    }
 }

src/bors/mod.rs

@@ -1,3 +1,9 @@
+use crate::config::RepositoryConfig;
+use crate::github::GithubRepoName;
+use crate::github::api::client::GithubRepositoryClient;
+use crate::permissions::UserPermissions;
+#[cfg(test)]
+use crate::tests::TestSyncMarker;
 use arc_swap::ArcSwap;
 use chrono::{DateTime, Utc};
 pub use command::CommandParser;
@@ -8,20 +14,14 @@ pub use handlers::{handle_bors_global_event, handle_bors_repository_event};
 use itertools::Itertools;
 use octocrab::models::RunId;
 use octocrab::models::workflows::Job;
+use regex::{Regex, RegexBuilder};
 use serde::Serialize;
 use std::collections::HashMap;
 use std::fmt;
 use std::str::FromStr;
-use std::sync::{Arc, RwLock};
+use std::sync::{Arc, LazyLock, RwLock};
 use std::time::Duration;
 
-use crate::config::RepositoryConfig;
-use crate::github::GithubRepoName;
-use crate::github::api::client::GithubRepositoryClient;
-use crate::permissions::UserPermissions;
-#[cfg(test)]
-use crate::tests::TestSyncMarker;
-
 mod build;
 mod build_queue;
 mod command;
@@ -258,16 +258,37 @@ impl FromStr for PullRequestStatus {
     }
 }
 
-/// Prefix used to specify custom try jobs in PR descriptions.
-pub const CUSTOM_TRY_JOB_PREFIX: &str = "try-job:";
-
 #[derive(Debug, Clone)]
 pub enum MergeType {
     Try { try_jobs: Vec<String> },
     Auto,
 }
 
+/// HTML comment that marks the start of a bors ignore block.
+/// The block is called "homu" to maintain compatibility with the old bors implementation
+/// (called homu).
+const IGNORE_BLOCK_START: &str = "<!-- homu-ignore:start -->";
+/// HTML comment that marks the end of a bors ignore block.
+const IGNORE_BLOCK_END: &str = "<!-- homu-ignore:end -->";
+
+/// Returns a string with the given content that will be ignored by bors on GitHub.
+pub fn make_text_ignored_by_bors(text: &str) -> String {
+    format!("{IGNORE_BLOCK_START}\n{text}\n{IGNORE_BLOCK_END}")
+}
+
 pub fn create_merge_commit_message(pr: handlers::PullRequestData, merge_type: MergeType) -> String {
+    /// Prefix used to specify custom try jobs in PR descriptions.
+    const CUSTOM_TRY_JOB_PREFIX: &str = "try-job:";
+
+    static IGNORE_REGEX: LazyLock<Regex> = LazyLock::new(|| {
+        RegexBuilder::new(r"<!--\s*homu-ignore:start\s*-->.*?<!--\s*homu-ignore:end\s*-->")
+            .multi_line(true)
+            .case_insensitive(true)
+            .dot_matches_new_line(true)
+            .build()
+            .unwrap()
+    });
+
     let pr_number = pr.number();
 
     let reviewer = match &merge_type {
@@ -290,6 +311,7 @@ pub fn create_merge_commit_message(pr: handlers::PullRequestData, merge_type: Me
         MergeType::Try { .. } => String::new(),
         MergeType::Auto => pr.github.message.clone(),
     };
+    let pr_description = IGNORE_REGEX.replace_all(&pr_description, "");
 
     let mut message = format!(
         r#"Auto merge of #{pr_number} - {pr_label}, r={reviewer}

src/github/rollup.rs

@@ -1,5 +1,6 @@
 use super::{GithubRepoName, PullRequest, PullRequestNumber};
 use crate::PgDbClient;
+use crate::bors::make_text_ignored_by_bors;
 use crate::github::api::client::GithubRepositoryClient;
 use crate::github::api::operations::{ForcePush, MergeError};
 use crate::github::oauth::{OAuthClient, UserGitHubClient};
@@ -325,12 +326,13 @@ async fn create_rollup(
     body.push_str("\nr? @ghost");
 
     let similar_rollup_link = format!(
-        "{web_url}/queue/{repo_name}?prs={}",
+        "[Create a similar rollup]({web_url}/queue/{repo_name}?prs={})",
         pr_nums.iter().copied().map(|s| s.to_string()).join(",")
     );
     writeln!(
         body,
-        "\n\n[Create a similar rollup]({similar_rollup_link})\n"
+        "\n\n{}\n",
+        make_text_ignored_by_bors(&similar_rollup_link)
     )?;
 
     let title = format!("Rollup of {} pull requests", successes.len());
@@ -472,7 +474,9 @@ mod tests {
 
         r? @ghost
 
+        <!-- homu-ignore:start -->
         [Create a similar rollup](https://bors-test.com/queue/borstest?prs=2,3,4,5)
+        <!-- homu-ignore:end -->
         ");
     }
 
@@ -510,7 +514,9 @@ mod tests {
 
         r? @ghost
 
+        <!-- homu-ignore:start -->
         [Create a similar rollup](https://bors-test.com/queue/borstest?prs=2,3,4)
+        <!-- homu-ignore:end -->
         ");
     }
 
@@ -542,7 +548,9 @@ mod tests {
 
         r? @ghost
 
+        <!-- homu-ignore:start -->
         [Create a similar rollup](https://bors-test.com/queue/borstest?prs=2,3)
+        <!-- homu-ignore:end -->
         ");
     }
 
@@ -580,7 +588,9 @@ mod tests {
 
         r? @ghost
 
+        <!-- homu-ignore:start -->
         [Create a similar rollup](https://bors-test.com/queue/borstest?prs=2,3,4,5)
+        <!-- homu-ignore:end -->
         ");
     }
 
@@ -607,7 +617,9 @@ mod tests {
 
         r? @ghost
 
+        <!-- homu-ignore:start -->
         [Create a similar rollup](https://bors-test.com/queue/borstest?prs=3,2)
+        <!-- homu-ignore:end -->
         ");
     }