updated and roadmap

ndbroadbent · ndbroadbent · commit 956baf1d7533 · 2025-10-04T08:59:41.000+13:00
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -76,6 +76,10 @@ export default defineConfig({
           label: 'Reference',
           items: [{ label: 'Requirements', slug: 'reference/requirements' }],
         },
+        {
+          label: 'Project',
+          items: [{ label: 'Roadmap', slug: 'roadmap' }],
+        },
       ],
     }),
   ],
diff --git a/docs/src/content/docs/roadmap.mdx b/docs/src/content/docs/roadmap.mdx
@@ -0,0 +1,56 @@
+---
+title: Roadmap
+description: Future features and enhancements planned for cigen
+---
+
+## CI Provider Support
+
+### GitHub Actions
+
+Full support for GitHub Actions workflows, including:
+
+- Matrix builds
+- Reusable workflows
+- GitHub-specific features (caching, artifacts, etc.)
+- Environment and deployment support
+
+### Buildkite
+
+Native Buildkite pipeline generation with:
+
+- Dynamic pipelines
+- Plugin support
+- Agent targeting
+- Artifact management
+
+### Jenkins
+
+Jenkins pipeline generation supporting:
+
+- Declarative pipelines
+- Jenkinsfile generation
+- Plugin integration
+- Multi-branch support
+
+## Local Execution
+
+First-class support for running all your CI jobs locally, similar to tools like Taskfile and [act](https://github.com/nektos/act):
+
+- **Docker-based execution** - Run jobs in isolated containers matching your CI environment
+- **Native execution** - Run jobs directly on your machine for faster iteration
+- **Selective job execution** - Run individual jobs or entire workflows
+- **Environment parity** - Use the same configuration for CI and local runs
+
+This enables rapid development and testing without pushing to CI.
+
+## CLI Workflow Management
+
+Interactive CLI tools to manage your CI pipelines:
+
+- **Job status monitoring** - View real-time status of running jobs across providers
+- **Log fetching** - Download and view logs for failing jobs
+- **Local reproduction** - Automatically re-run failing tests on your machine with the same environment
+- **Pipeline control** - Trigger, cancel, or retry jobs from the command line
+- **Cross-provider interface** - Unified CLI regardless of which CI provider you use
+
+This brings the power of CI/CD management directly to your terminal.
diff --git a/src/models/config.rs b/src/models/config.rs
@@ -396,6 +396,9 @@ pub struct SetupOptions {
 
     #[serde(skip_serializing_if = "Option::is_none")]
     pub runtime_image: Option<String>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub compile_cigen: Option<bool>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
diff --git a/src/providers/circleci/generator.rs b/src/providers/circleci/generator.rs
@@ -338,13 +338,27 @@ impl CircleCIGenerator {
             .insert("setup".to_string(), setup_workflow);
 
         // Build setup job
-        // Choose setup runtime image: prefer configured one,
-        // else default to docspringcom/cigen:latest
+        // Choose setup runtime image based on configuration:
+        // 1. If runtime_image is explicitly set, use it
+        // 2. If compile_cigen is true, use Rust image for compilation
+        // 3. Otherwise default to docspringcom/cigen:latest (has cigen pre-installed + openssh-client)
+        let compile_cigen = config
+            .setup_options
+            .as_ref()
+            .and_then(|o| o.compile_cigen)
+            .unwrap_or(false);
+
         let setup_image = config
             .setup_options
             .as_ref()
             .and_then(|o| o.runtime_image.clone())
-            .unwrap_or_else(|| "docspringcom/cigen:latest".to_string());
+            .unwrap_or_else(|| {
+                if compile_cigen {
+                    "cimg/rust:1.75".to_string()
+                } else {
+                    "docspringcom/cigen:latest".to_string()
+                }
+            });
 
         let mut setup_job = cc::CircleCIJob {
             executor: None,
@@ -388,6 +402,31 @@ impl CircleCIGenerator {
             setup_job.steps.push(cc::CircleCIStep::new(checkout_step));
         }
 
+        // Optional cigen compilation from source for testing cigen changes on CI
+        if compile_cigen {
+            // Checkout cigen repository
+            let checkout_cigen_cmd = r#"set -euo pipefail
+echo "Checking out cigen from GitHub..."
+git clone --depth 1 https://github.com/DocSpring/cigen.git /tmp/cigen
+cd /tmp/cigen"#;
+            setup_job.steps.push(cc::CircleCIStep::new(run_step(
+                "Checkout cigen repository",
+                checkout_cigen_cmd,
+            )));
+
+            // Compile cigen from source
+            let compile_cigen_cmd = r#"set -euo pipefail
+cd /tmp/cigen
+echo "Compiling cigen from source..."
+cargo build --release
+echo "Cigen compiled successfully"
+echo "export PATH=\"/tmp/cigen/target/release:\$PATH\"" >> $BASH_ENV"#;
+            setup_job.steps.push(cc::CircleCIStep::new(run_step(
+                "Compile cigen from source",
+                compile_cigen_cmd,
+            )));
+        }
+
         // Optional self-check to ensure entrypoint is up to date
         if let Some(opts) = &config.setup_options
             && let Some(sc) = &opts.self_check
diff --git a/src/providers/circleci/templates/shallow_checkout.yml b/src/providers/circleci/templates/shallow_checkout.yml
@@ -66,6 +66,19 @@ steps:
         KEYSCAN_BITBUCKET="<< parameters.keyscan_bitbucket >>"
         CHECKOUT_PATH="<< parameters.path >>"
 
+        # Verify ssh is available (required for git ssh operations and keyscan)
+        if ! command -v ssh >/dev/null 2>&1; then
+            echo "ERROR: ssh command not found" >&2
+            echo "" >&2
+            echo "You must run this command from a Docker image that has openssh-client installed." >&2
+            echo "" >&2
+            echo "Use a CircleCI convenience image (cimg/*) or install openssh-client in your Dockerfile:" >&2
+            echo "  - Debian/Ubuntu: RUN apt-get update && apt-get install -y openssh-client" >&2
+            echo "  - Alpine: RUN apk add --no-cache openssh-client" >&2
+            echo "  - RHEL/CentOS: RUN yum install -y openssh-clients" >&2
+            exit 1
+        fi
+
         # Create SSH directory if not exists
         if [ ! -d ~/.ssh ]; then
             mkdir -p ~/.ssh
diff --git a/tests/snapshots/snapshot_circleci_rails__circleci_rails_config.snap b/tests/snapshots/snapshot_circleci_rails__circleci_rails_config.snap
@@ -59,6 +59,19 @@ commands:
           KEYSCAN_BITBUCKET="<< parameters.keyscan_bitbucket >>"
           CHECKOUT_PATH="<< parameters.path >>"
 
+          # Verify ssh is available (required for git ssh operations and keyscan)
+          if ! command -v ssh >/dev/null 2>&1; then
+              echo "ERROR: ssh command not found" >&2
+              echo "" >&2
+              echo "You must run this command from a Docker image that has openssh-client installed." >&2
+              echo "" >&2
+              echo "Use a CircleCI convenience image (cimg/*) or install openssh-client in your Dockerfile:" >&2
+              echo "  - Debian/Ubuntu: RUN apt-get update && apt-get install -y openssh-client" >&2
+              echo "  - Alpine: RUN apk add --no-cache openssh-client" >&2
+              echo "  - RHEL/CentOS: RUN yum install -y openssh-clients" >&2
+              exit 1
+          fi
+
           # Create SSH directory if not exists
           if [ ! -d ~/.ssh ]; then
               mkdir -p ~/.ssh

Original file line number	Diff line number	Diff line change
`@@ -396,6 +396,9 @@ pub struct SetupOptions {`
`396`	`396`
`397`	`397`	`#[serde(skip_serializing_if = "Option::is_none")]`
`398`	`398`	`pub runtime_image: Option<String>,`
	`399`	`+`
	`400`	`+ #[serde(skip_serializing_if = "Option::is_none")]`
	`401`	`+ pub compile_cigen: Option<bool>,`
`399`	`402`	`}`
`400`	`403`
`401`	`404`	`#[derive(Debug, Clone, Serialize, Deserialize)]`