Switch from commit statuses to check suites

Author: Sakib25800

src/bors/handlers/workflow.rs

@@ -1,7 +1,7 @@
 use std::sync::Arc;
 use std::time::Duration;
 
-use octocrab::models::StatusState;
+use octocrab::params::checks::{CheckRunConclusion, CheckRunStatus};
 
 use crate::PgDbClient;
 use crate::bors::CheckSuiteStatus;
@@ -261,15 +261,31 @@ async fn complete_auto_build(
     };
     repo.client.post_comment(pr.number, comment).await?;
 
-    let (status, desc) = if !has_failure {
-        (StatusState::Success, "Build succeeded")
+    let (status, conclusion, desc) = if !has_failure {
+        (
+            CheckRunStatus::Completed,
+            Some(CheckRunConclusion::Success),
+            "Build succeeded",
+        )
     } else {
-        (StatusState::Failure, "Build failed")
+        (
+            CheckRunStatus::Completed,
+            Some(CheckRunConclusion::Failure),
+            "Build failed",
+        )
     };
 
     let gh_pr = repo.client.get_pull_request(pr.number).await?;
     repo.client
-        .create_commit_status(&gh_pr.head.sha, status, None, Some(desc), Some("bors"))
+        .create_check_run(
+            &gh_pr.head.sha,
+            "bors",
+            status,
+            conclusion,
+            Some("Bors build status"),
+            Some(desc),
+            None,
+        )
         .await?;
 
     Ok(())

src/bors/merge_queue.rs

@@ -1,5 +1,5 @@
 use anyhow::anyhow;
-use octocrab::models::StatusState;
+use octocrab::params::checks::{CheckRunConclusion, CheckRunStatus};
 use std::sync::{Arc, OnceLock};
 use tokio::sync::Mutex;
 
@@ -96,12 +96,14 @@ pub async fn handle_merge_queue(ctx: Arc<BorsContext>) -> anyhow::Result<()> {
                                     &error.to_string()
                                 );
                                 repo.client
-                                    .create_commit_status(
+                                    .create_check_run(
                                         &gh_pr.head.sha,
-                                        StatusState::Error,
-                                        None,
+                                        "bors",
+                                        CheckRunStatus::Completed,
+                                        Some(CheckRunConclusion::Failure),
+                                        Some("Bors build status"),
                                         Some(&desc),
-                                        Some("bors"),
+                                        None,
                                     )
                                     .await?;
 
@@ -195,18 +197,20 @@ async fn start_auto_build(
                 )
                 .await?;
 
-            // 4. Set GitHub commit status to pending on PR head
+            // 4. Set GitHub check run to pending on PR head
             let desc = format!(
                 "Testing commit {} with merge {}...",
                 gh_pr.head.sha, merge_sha
             );
             client
-                .create_commit_status(
+                .create_check_run(
                     &gh_pr.head.sha,
-                    StatusState::Pending,
+                    "bors",
+                    CheckRunStatus::InProgress,
                     None,
+                    Some("Bors build status"),
                     Some(&desc),
-                    Some("bors"),
+                    None,
                 )
                 .await?;
 
@@ -225,15 +229,17 @@ async fn start_auto_build(
                 .update_pr_mergeable_state(&pr, MergeableState::HasConflicts)
                 .await?;
 
-            // 3. Set GitHub commit status to error on PR head
+            // 3. Set GitHub check run to error on PR head
             // We don't set it to failure as this issue is likely on GitHub's end.
             client
-                .create_commit_status(
+                .create_check_run(
                     &gh_pr.head.sha,
-                    StatusState::Error,
-                    None,
+                    "bors",
+                    CheckRunStatus::Completed,
+                    Some(CheckRunConclusion::Failure),
+                    Some("Bors build status"),
                     Some("Merge conflict"),
-                    Some("bors"),
+                    None,
                 )
                 .await?;
 

src/github/api/client.rs

@@ -1,6 +1,7 @@
 use anyhow::Context;
 use octocrab::Octocrab;
-use octocrab::models::{App, Repository, StatusState};
+use octocrab::models::{App, Repository};
+use octocrab::params::checks::{CheckRunConclusion, CheckRunOutput, CheckRunStatus};
 use tracing::log;
 
 use crate::bors::event::PullRequestComment;
@@ -347,35 +348,44 @@ impl GithubRepositoryClient {
         Ok(prs)
     }
 
-    /// Create a commit status for the given SHA.
-    pub async fn create_commit_status(
+    /// Create a check run for the given SHA.
+    #[allow(clippy::too_many_arguments)]
+    pub async fn create_check_run(
         &self,
         sha: &CommitSha,
-        state: StatusState,
-        target_url: Option<&str>,
-        description: Option<&str>,
-        context: Option<&str>,
+        name: &str,
+        status: CheckRunStatus,
+        conclusion: Option<CheckRunConclusion>,
+        output_title: Option<&str>,
+        output_summary: Option<&str>,
+        details_url: Option<&str>,
     ) -> anyhow::Result<()> {
-        perform_network_request_with_retry("create_commit_status", || async {
-            let repos = self
+        perform_network_request_with_retry("create_check_run", || async {
+            let checks = self
                 .client
-                .repos(&self.repository().owner, &self.repository().name);
-            let mut builder = repos.create_status(sha.0.clone(), state);
+                .checks(&self.repository().owner, &self.repository().name);
+            let mut builder = checks.create_check_run(name, sha.0.clone()).status(status);
 
-            if let Some(url) = target_url {
-                builder = builder.target(url.to_string());
+            if let Some(conclusion) = conclusion {
+                builder = builder.conclusion(conclusion);
             }
-            if let Some(desc) = description {
-                builder = builder.description(desc.to_string());
+
+            if let (Some(title), Some(summary)) = (output_title, output_summary) {
+                let output = CheckRunOutput {
+                    title: title.to_string(),
+                    summary: summary.to_string(),
+                    text: None,
+                    annotations: Vec::new(),
+                    images: Vec::new(),
+                };
+                builder = builder.output(output);
             }
-            if let Some(ctx) = context {
-                builder = builder.context(ctx.to_string());
+
+            if let Some(url) = details_url {
+                builder = builder.details_url(url);
             }
 
-            builder
-                .send()
-                .await
-                .context("Cannot create commit status")?;
+            builder.send().await.context("Cannot create check run")?;
             Ok(())
         })
         .await?