om ci: Group log output in github actions (#413)

Author: niksingh710

crates/omnix-ci/src/command/run.rs

@@ -1,6 +1,8 @@
 //! The run command
 use std::{
     collections::HashMap,
+    env,
+    future::Future,
     io::Write,
     path::{Path, PathBuf},
 };
@@ -20,7 +22,10 @@ use omnix_common::config::OmConfig;
 use omnix_health::{traits::Checkable, NixHealth};
 use serde::{Deserialize, Serialize};
 
-use crate::{config::subflakes::SubflakesConfig, flake_ref::FlakeRef, step::core::StepsResult};
+use crate::{
+    config::subflakes::SubflakesConfig, flake_ref::FlakeRef, github::actions::in_github_log_group,
+    step::core::StepsResult,
+};
 
 use super::run_remote;
 
@@ -64,6 +69,10 @@ pub struct RunCommand {
     #[arg(default_value = ".")]
     pub flake_ref: FlakeRef,
 
+    /// Print Github Actions log groups (enabled by default when run in Github Actions)
+    #[clap(long, default_value_t = env::var("GITHUB_ACTION").is_ok())]
+    pub github_output: bool,
+
     /// Arguments for all steps
     #[command(flatten)]
     pub steps_args: crate::step::core::StepsArgs,
@@ -114,15 +123,22 @@ impl RunCommand {
         // TODO: We'll refactor this function to use steps
         // https://github.com/juspay/omnix/issues/216
 
-        tracing::info!("{}", "\n👟 Gathering NixInfo".bold());
-        let nix_info = NixInfo::get()
-            .await
-            .as_ref()
-            .with_context(|| "Unable to gather nix info")?;
+        let nix_info = in_github_log_group("info", self.github_output, || async {
+            tracing::info!("{}", "\n👟 Gathering NixInfo".bold());
+            NixInfo::get()
+                .await
+                .as_ref()
+                .with_context(|| "Unable to gather nix info")
+        })
+        .await?;
 
         // First, run the necessary health checks
-        tracing::info!("{}", "\n🫀 Performing health check".bold());
-        check_nix_version(&cfg, nix_info).await?;
+        in_github_log_group("health", self.github_output, || async {
+            tracing::info!("{}", "\n🫀 Performing health check".bold());
+            // check_nix_version(&cfg, nix_info).await?;
+            check_nix_version(&cfg, nix_info).await
+        })
+        .await?;
 
         // Then, do the CI steps
         tracing::info!(
@@ -131,24 +147,36 @@ impl RunCommand {
         );
         let res = ci_run(&self.nixcmd, verbose, self, &cfg, &nix_info.nix_config).await?;
 
-        let m_out_link = self.get_out_link();
-        let s = serde_json::to_string(&res)?;
-        let mut path = tempfile::Builder::new()
-            .prefix("om-ci-results-")
-            .suffix(".json")
-            .tempfile()?;
-        path.write_all(s.as_bytes())?;
-
-        let results_path =
-            addstringcontext::addstringcontext(&self.nixcmd, path.path(), m_out_link).await?;
-        println!("{}", results_path.display());
-        if let Some(m_out_link) = m_out_link {
-            tracing::info!(
-                "Result available at {:?} and symlinked at {:?}",
-                results_path.as_path(),
-                m_out_link
-            );
-        }
+        let msg = in_github_log_group::<anyhow::Result<String>, _, _>(
+            "outlink",
+            self.github_output,
+            || async {
+                let m_out_link = self.get_out_link();
+                let s = serde_json::to_string(&res)?;
+                let mut path = tempfile::Builder::new()
+                    .prefix("om-ci-results-")
+                    .suffix(".json")
+                    .tempfile()?;
+                path.write_all(s.as_bytes())?;
+
+                let results_path =
+                    addstringcontext::addstringcontext(&self.nixcmd, path.path(), m_out_link)
+                        .await?;
+                println!("{}", results_path.display());
+
+                let msg = format!(
+                    "Result available at {:?}{}",
+                    results_path.as_path(),
+                    m_out_link
+                        .map(|p| format!(" and symlinked at {:?}", p))
+                        .unwrap_or_default()
+                );
+                Ok(msg)
+            },
+        )
+        .await?;
+
+        tracing::info!("{}", msg);
 
         Ok(())
     }
@@ -213,7 +241,7 @@ pub async fn check_nix_version(cfg: &OmConfig, nix_info: &NixInfo) -> anyhow::Re
     Ok(())
 }
 
-/// Run CI fo all subflakes
+/// Run CI for all subflakes
 pub async fn ci_run(
     cmd: &NixCmd,
     verbose: bool,
@@ -249,11 +277,18 @@ pub async fn ci_run(
             continue;
         }
 
-        tracing::info!("\n🍎 {}", name);
-        let steps_res = subflake
-            .steps
-            .run(cmd, verbose, run_cmd, &systems, &cfg.flake_url, subflake)
-            .await?;
+        let steps_res = in_github_log_group(
+            &format!("subflake={}", name),
+            run_cmd.github_output,
+            || async {
+                tracing::info!("\n🍎 {}", name);
+                subflake
+                    .steps
+                    .run(cmd, verbose, run_cmd, &systems, &cfg.flake_url, subflake)
+                    .await
+            },
+        )
+        .await?;
         res.insert(subflake_name.clone(), steps_res);
     }
 

crates/omnix-ci/src/github/actions.rs

@@ -0,0 +1,24 @@
+//! Working with GitHub Actions
+
+use std::{future::Future, io::Write};
+
+/// Group log lines in GitHub Actions
+///
+/// https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#grouping-log-lines
+pub async fn in_github_log_group<T, F, Fut>(name: &str, enable: bool, f: F) -> T
+where
+    F: FnOnce() -> Fut,
+    Fut: Future<Output = T>,
+{
+    if enable {
+        eprintln!("::group::{}", name);
+    }
+
+    let result = f().await;
+
+    if enable {
+        eprintln!("::endgroup::");
+    }
+
+    result
+}

crates/omnix-ci/src/github/mod.rs

@@ -1,3 +1,4 @@
 //! GitHub related types and functions.
+pub mod actions;
 pub mod matrix;
 pub mod pull_request;