Add copilot-setup-steps.yml for GitHub Copilot Coding Agent

copilot-setup-steps.yml

@@ -0,0 +1,47 @@
+##############################
+# THIS FILE IS AUTOGENERATED #
+#    DO NOT MANUALLY EDIT    #
+##############################
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# GitHub Copilot setup steps for OpenVMM development environment
+# Generated by flowey_hvlite - DO NOT EDIT MANUALLY
+
+steps:
+  - name: Install Rust with required targets
+    run: |
+      # Install Rust using rustup (version managed by flowey)
+      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain 1.88.0
+      source ~/.cargo/env
+
+      # Install targets for the host architecture
+      ARCH=$(uname -m)
+      if [ "$ARCH" = "x86_64" ]; then
+        rustup target add x86_64-unknown-linux-musl
+      elif [ "$ARCH" = "aarch64" ]; then
+        rustup target add aarch64-unknown-linux-musl
+      fi
+
+  - name: Install system dependencies
+    run: |
+      # Update package lists
+      sudo apt-get update
+
+      # Install build dependencies required for OpenVMM
+      sudo apt-get install -y \
+        binutils \
+        build-essential \
+        gcc-aarch64-linux-gnu \
+        libssl-dev \
+        pkg-config
+
+  - name: Restore OpenVMM build dependencies
+    run: |
+      # Restore external dependencies required for building OpenVMM
+      # This includes protoc (Protocol Buffers compiler), mu_msvm UEFI firmware, 
+      # test Linux kernels, and other build artifacts
+      cargo xflowey restore-packages
+
+      # Install cargo-nextest for running unit tests (version managed by flowey)
+      cargo install cargo-nextest --version 0.9.96 --locked

flowey/flowey_cli/src/cli/regen.rs

@@ -100,6 +100,17 @@ impl Regen {
             }
         }
 
+        // Generate copilot-setup-steps.yml using flowey's version management
+        // This ensures the file uses the correct Rust and tool versions
+        let copilot_result = generate_copilot_setup_steps_file(repo_root);
+        if copilot_result.is_err() {
+            error = true;
+            log::error!(
+                "Failed to generate copilot-setup-steps.yml: {:?}",
+                copilot_result
+            );
+        }
+
         if error {
             anyhow::bail!("encountered one or more errors")
         }
@@ -197,3 +208,18 @@ fn install_flowey_merge_driver() -> anyhow::Result<()> {
 
     Ok(())
 }
+
+fn generate_copilot_setup_steps_file(repo_root: &Path) -> anyhow::Result<()> {
+    // Run the copilot setup generator command
+    let sh = xshell::Shell::new()?;
+    sh.change_dir(repo_root);
+    xshell::cmd!(
+        sh,
+        "cargo run -p flowey_hvlite -- pipeline run copilot-setup-generator"
+    )
+    .quiet()
+    .run()?;
+
+    log::info!("Generated copilot-setup-steps.yml");
+    Ok(())
+}

flowey/flowey_hvlite/src/pipelines/copilot_setup_generator.rs

@@ -0,0 +1,76 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use anyhow::Result;
+
+/// Generate copilot-setup-steps.yml for GitHub Copilot Coding Agent
+#[derive(clap::Args)]
+pub struct CopilotSetupGeneratorCli {}
+
+impl CopilotSetupGeneratorCli {
+    pub fn run(self, repo_root: &std::path::Path) -> Result<()> {
+        let output_file = repo_root.join("copilot-setup-steps.yml");
+
+        let content = generate_copilot_setup_steps();
+
+        std::fs::write(&output_file, content)?;
+
+        println!("Generated copilot-setup-steps.yml");
+        Ok(())
+    }
+}
+
+fn generate_copilot_setup_steps() -> String {
+    format!(
+        r#"##############################
+# THIS FILE IS AUTOGENERATED #
+#    DO NOT MANUALLY EDIT    #
+##############################
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# GitHub Copilot setup steps for OpenVMM development environment
+# Generated by flowey_hvlite - DO NOT EDIT MANUALLY
+
+steps:
+  - name: Install Rust with required targets
+    run: |
+      # Install Rust using rustup (version managed by flowey)
+      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain {rust_version}
+      source ~/.cargo/env
+
+      # Install targets for the host architecture
+      ARCH=$(uname -m)
+      if [ "$ARCH" = "x86_64" ]; then
+        rustup target add x86_64-unknown-linux-musl
+      elif [ "$ARCH" = "aarch64" ]; then
+        rustup target add aarch64-unknown-linux-musl
+      fi
+
+  - name: Install system dependencies
+    run: |
+      # Update package lists
+      sudo apt-get update
+
+      # Install build dependencies required for OpenVMM
+      sudo apt-get install -y \
+        binutils \
+        build-essential \
+        gcc-aarch64-linux-gnu \
+        libssl-dev \
+        pkg-config
+
+  - name: Restore OpenVMM build dependencies
+    run: |
+      # Restore external dependencies required for building OpenVMM
+      # This includes protoc (Protocol Buffers compiler), mu_msvm UEFI firmware, 
+      # test Linux kernels, and other build artifacts
+      cargo xflowey restore-packages
+
+      # Install cargo-nextest for running unit tests (version managed by flowey)
+      cargo install cargo-nextest --version {nextest_version} --locked
+"#,
+        rust_version = flowey_lib_hvlite::_jobs::cfg_versions::RUSTUP_TOOLCHAIN,
+        nextest_version = flowey_lib_hvlite::_jobs::cfg_versions::NEXTEST
+    )
+}

flowey/flowey_hvlite/src/pipelines/mod.rs

@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+use copilot_setup_generator::CopilotSetupGeneratorCli;
 use flowey::pipeline::prelude::*;
 use restore_packages::RestorePackagesCli;
 use vmm_tests::VmmTestsCli;
 
 pub mod build_docs;
 pub mod build_igvm;
 pub mod checkin_gates;
+pub mod copilot_setup_generator;
 pub mod custom_vmfirmwareigvm_dll;
 pub mod restore_packages;
 pub mod vmm_tests;
@@ -29,6 +31,9 @@ pub enum OpenvmmPipelines {
     #[clap(subcommand)]
     Ci(OpenvmmPipelinesCi),
 
+    /// Generate copilot-setup-steps.yml file directly  
+    CopilotSetupGenerator(CopilotSetupGeneratorCli),
+
     /// Install tools needed to build OpenVMM
     RestorePackages(RestorePackagesCli),
 
@@ -59,6 +64,11 @@ impl IntoPipeline for OpenvmmPipelines {
                 OpenvmmPipelinesCi::CheckinGates(cmd) => cmd.into_pipeline(pipeline_hint),
                 OpenvmmPipelinesCi::BuildDocs(cmd) => cmd.into_pipeline(pipeline_hint),
             },
+            OpenvmmPipelines::CopilotSetupGenerator(cmd) => {
+                cmd.run(&crate::repo_root())?;
+                // Return empty pipeline since we've already done the work
+                Ok(Pipeline::new())
+            }
             OpenvmmPipelines::RestorePackages(cmd) => cmd.into_pipeline(pipeline_hint),
             OpenvmmPipelines::VmmTests(cmd) => cmd.into_pipeline(pipeline_hint),
         }