feat: add .cigen/ config for self-hosting

ndbroadbent · claude · ndbroadbent · commit 53ccb1bb397b · 2025-10-04T12:36:46.000+13:00
Created cigen's own CI configuration using cigen itself - demonstrating the "write once, run anywhere" philosophy. New files: - .cigen/config.yml - Main config with source file groups for job skipping - .cigen/workflows/ci.yml - CI workflow definition with job dependencies - .cigen/workflows/ci/jobs/clippy.yml .cigen/workflows/ci/jobs/fmt.yml .cigen/workflows/ci/jobs/test.yml - Individual job definitions (fmt, clippy, test) Job definitions: - fmt: Cargo format check with @rust source files - clippy: Linter with @rust source files - test: Full test suite with @rust, @tests, @examples source files - test depends on fmt + clippy passing Features demonstrated: - Source file groups (@rust, @tests, @examples, @docs) - Job skipping based on file changes - Job dependencies (test requires fmt + clippy) - Automatic cache injection (will use actions/cache@v4) Also updated: - Batch renamed cigen.yml → config.yml in docs and notes - Updated CLAUDE.md, various documentation files - Updated loader and validator to reflect config.yml convention Next: Generate GitHub Actions workflow from this config 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/.cigen/config.yml b/.cigen/config.yml
@@ -0,0 +1,23 @@
+provider: github-actions
+output_path: .github/workflows
+
+# Source file groups for job skipping
+source_file_groups:
+  rust:
+    - "src/**/*.rs"
+    - "Cargo.toml"
+    - "Cargo.lock"
+
+  tests:
+    - "tests/**/*.rs"
+    - "tests/**/*.yml"
+    - "tests/**/*.trycmd"
+
+  examples:
+    - "examples/**/*.yml"
+    - "examples/**/*.yaml"
+
+  docs:
+    - "*.md"
+    - "docs/**/*.md"
+    - "notes/**/*.md"
diff --git a/.cigen/workflows/ci.yml b/.cigen/workflows/ci.yml
@@ -0,0 +1,7 @@
+jobs:
+  fmt:
+  clippy:
+  test:
+    requires:
+      - fmt
+      - clippy
diff --git a/.cigen/workflows/ci/jobs/clippy.yml b/.cigen/workflows/ci/jobs/clippy.yml
@@ -0,0 +1,6 @@
+image: rust:latest
+source_files: "@rust"
+
+steps:
+  - name: Clippy check
+    run: cargo clippy --all-targets --all-features -- -D warnings
diff --git a/.cigen/workflows/ci/jobs/fmt.yml b/.cigen/workflows/ci/jobs/fmt.yml
@@ -0,0 +1,6 @@
+image: rust:latest
+source_files: "@rust"
+
+steps:
+  - name: Format check
+    run: cargo fmt -- --check
diff --git a/.cigen/workflows/ci/jobs/test.yml b/.cigen/workflows/ci/jobs/test.yml
@@ -0,0 +1,9 @@
+image: rust:latest
+source_files:
+  - "@rust"
+  - "@tests"
+  - "@examples"
+
+steps:
+  - name: Run tests
+    run: cargo test --all-features
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -257,7 +257,7 @@ You can also reference `/Users/ndbroadbent/code/docspring/lib/tools/generate_cir
 
 ## Use Our Own Tool
 
-The goal is to eventually become 'self-hosting' for our own CI pipeline on GitHub Actions. We must have `nx.json` and `project.json` file in the root of the repository, a `.cigen/` directory, and a `.cigen/cigen.yml` file.
+The goal is to eventually become 'self-hosting' for our own CI pipeline on GitHub Actions. We must have `nx.json` and `project.json` file in the root of the repository, a `.cigen/` directory, and a `.cigen/config.yml` file.
 
 We will start by hand-writing our own GitHub Actions workflow files, but eventually migrate to using `cigen` to generate our CI configuration.
 
@@ -289,13 +289,13 @@ When working on DocSpring configuration conversion:
 
 ## Split Configuration
 
-**IMPORTANT**: CIGen supports a "split config" style where different top-level keys can be refactored into their own files under `.cigen/config/`, and it all gets merged together. This prevents `.cigen/cigen.yml` from becoming unmaintainable.
+**IMPORTANT**: CIGen supports a "split config" style where different top-level keys can be refactored into their own files under `.cigen/config/`, and it all gets merged together. This prevents `.cigen/config.yml` from becoming unmaintainable.
 
 We MUST use split config for large configuration sections:
 
 - Source file groups are already split: `docspring/.cigen/config/source_file_groups.yml`
 - Any other config section that grows beyond ~20 lines should be split into its own file
-- Files in `.cigen/config/` are automatically merged with the main `cigen.yml`
+- Files in `.cigen/config/` are automatically merged with the main `config.yml`
 - Use descriptive filenames that match the top-level key (e.g., `cache_definitions.yml` for cache definitions)
 
 ## Key Concepts
diff --git a/docs/src/content/docs/advanced/job-skipping.mdx b/docs/src/content/docs/advanced/job-skipping.mdx
@@ -16,14 +16,14 @@ Cigen contains an initial scaffold for job skipping based on a hash of source fi
 ## How It Works
 
 <Steps>
-  1. Calculate SHA-256 hash of configured source files
-  2. Check for a local skip marker file for that hash
-  3. If present, halt remaining steps (CircleCI)
-  4. Otherwise, run the job and write the marker file at the end
+  1. Calculate SHA-256 hash of configured source files 2. Check for a local skip
+  marker file for that hash 3. If present, halt remaining steps (CircleCI) 4.
+  Otherwise, run the job and write the marker file at the end
 </Steps>
 
 <Aside type="tip">
-  This is non-persistent. Markers live under `/tmp` in the job container and are not restored across runs yet.
+  This is non-persistent. Markers live under `/tmp` in the job container and are
+  not restored across runs yet.
 </Aside>
 
 ## Source File Configuration
@@ -32,7 +32,7 @@ Cigen contains an initial scaffold for job skipping based on a hash of source fi
 
 Define reusable patterns in your configuration:
 
-<Code code={`# In cigen.yml or config/source_file_groups.yml
+<Code code={`# In config.yml or config/source_file_groups.yml
 source_file_groups:
   ruby:
     - '**/*.rb'
diff --git a/docs/src/content/docs/commands/generate.mdx b/docs/src/content/docs/commands/generate.mdx
@@ -93,7 +93,7 @@ For CircleCI (`provider: circleci`):
 
 ### Multi-Architecture Jobs
 
-<Code code={`# Input (cigen.yml):
+<Code code={`# Input (config.yml):
 jobs:
   build:
     architectures: [amd64, arm64]
@@ -112,7 +112,7 @@ resource_class: arm.medium`} lang="yaml" title="Architecture expansion" />
 
 ### Cache Injection
 
-<Code code={`# Input (cigen.yml):
+<Code code={`# Input (config.yml):
 jobs:
   test:
     cache: [node_modules]
@@ -194,7 +194,7 @@ Override built-in templates by placing files in your config directory:
 
 ```
 .cigen/
-├── cigen.yml
+├── config.yml
 ├── templates/
 │   └── custom_job.yml
 └── workflows/
diff --git a/docs/src/content/docs/commands/validate.mdx b/docs/src/content/docs/commands/validate.mdx
@@ -230,7 +230,7 @@ Structure your config for easier validation:
 
 ```
 .cigen/
-├── cigen.yml              # Main config
+├── config.yml              # Main config
 ├── jobs/                  # Job definitions
 ├── workflows/            # Workflow definitions
 └── templates/           # Custom templates
diff --git a/docs/src/content/docs/configuration/cache.mdx b/docs/src/content/docs/configuration/cache.mdx
@@ -43,27 +43,36 @@ Cigen ships default definitions for common technologies that you can extend or o
 
 ### Ruby Gems
 
-<Code code={`cache_definitions:
+<Code
+  code={`cache_definitions:
   gems:
     versions: [ruby, bundler]
     checksum_sources: [Gemfile, Gemfile.lock]
     paths: [vendor/bundle, .bundle]
-`} lang="yaml" title="Ruby cache definition (paths and sources)" />
+`}
+  lang="yaml"
+  title="Ruby cache definition (paths and sources)"
+/>
 
 ### Node.js Modules
 
-<Code code={`cache_definitions:
+<Code
+  code={`cache_definitions:
   node_modules:
     versions: [node]
     checksum_sources:
       - package.json
       - detect: [package-lock.json, yarn.lock, bun.lockb, pnpm-lock.yaml]
     paths: [node_modules]
-`} lang="yaml" title="Node.js cache definition" />
+`}
+  lang="yaml"
+  title="Node.js cache definition"
+/>
 
 ### Python Packages
 
-<Code code={`cache_definitions:
+<Code
+  code={`cache_definitions:
   pip:
     versions: [python, pip]
     checksum_sources:
@@ -72,7 +81,10 @@ Cigen ships default definitions for common technologies that you can extend or o
     paths:
       - detect: [.venv, venv]
       - ~/.cache/pip
-`} lang="yaml" title="Python cache definition" />
+`}
+  lang="yaml"
+  title="Python cache definition"
+/>
 
 ## Using Caches in Jobs
 
@@ -96,11 +108,12 @@ jobs:
 ```
 
 The `restore_cache` field is a shorthand for:
+
 ```yaml
 cache:
   gems:
-    restore: true  # Always true by default anyway
-    save: false    # This is what restore_cache does
+    restore: true # Always true by default anyway
+    save: false # This is what restore_cache does
 ```
 
 ### Simple Cache Usage
@@ -151,12 +164,11 @@ This injects a `restore_cache` step before, and a `save_cache` step after, when
   title="Customizing cache paths"
 />
 
-
 ## Advanced Cache Configuration
 
 ### Custom Cache Types
 
-<Code code={`# In cigen.yml
+<Code code={`# In config.yml
 cache_definitions:
   ml_models:
     versions: [python]
diff --git a/docs/src/content/docs/configuration/overview.mdx b/docs/src/content/docs/configuration/overview.mdx
@@ -54,16 +54,16 @@ POSTGRES_PASSWORD: test
 # Job definitions
 
 jobs:
-  test:
-    image: cimg/ruby:3.3
-    services: [postgres]
-    steps: [shallow_checkout, { run: bundle exec rspec }]
+test:
+image: cimg/ruby:3.3
+services: [postgres]
+steps: [shallow_checkout, { run: bundle exec rspec }]
 
 # Workflow definitions
 
 workflows:
 main:
-jobs: - test`} lang="yaml" title="Basic cigen.yml" />
+jobs: - test`} lang="yaml" title="Basic config.yml" />
 
 ## Directory Structure
 
@@ -73,14 +73,14 @@ Cigen supports both single-file and multi-file configurations:
 
 ```
 .cigen/
-└── cigen.yml
+└── config.yml
 ```
 
 ### Multi-File (Complex Projects)
 
 ```
 .cigen/
-├── cigen.yml              # Main configuration
+├── config.yml              # Main configuration
 ├── config/                # Split configuration files
 │   ├── services.yml
 │   └── cache.yml
diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx
@@ -78,7 +78,7 @@ Define your pipeline structure:
 
 ```
 .cigen/
-├── cigen.yml                    # Provider and global config
+├── config.yml                    # Provider and global config
 ├── config/
 │   └── source_file_groups.yml  # Reusable file patterns
 ├── workflows/
diff --git a/docs/src/content/docs/philosophy.mdx b/docs/src/content/docs/philosophy.mdx
@@ -95,7 +95,7 @@ Cigen detects platform capabilities and automatically:
 
 ### Job Caching
 
-```yaml title="cigen.yml"
+```yaml title="config.yml"
 # What you write:
 jobs:
   test:
@@ -133,7 +133,7 @@ jobs:
 
 ### OR Dependencies
 
-```yaml title="cigen.yml"
+```yaml title="config.yml"
 # What you write:
 jobs:
   deploy:
diff --git a/notes/CIRCLECI.md b/notes/CIRCLECI.md
@@ -35,7 +35,7 @@ When `circleci.fix_github_status: true` is set, cigen automatically injects a `p
 
 1. Create a GitHub personal access token with `repo:status` scope
 2. Add it to your CircleCI project as an environment variable named `GITHUB_PERSONAL_ACCESS_TOKEN`
-3. Enable the feature in your `cigen.yml` configuration
+3. Enable the feature in your `config.yml` configuration
 
 The patch job is automatically injected when:
 
diff --git a/notes/CONFIG_FORMAT.md b/notes/CONFIG_FORMAT.md
@@ -406,7 +406,7 @@ CIGen can generate multiple output files from a single configuration, useful for
 ### Configuration
 
 ```yaml
-# .cigen/cigen.yml
+# .cigen/config.yml
 provider: circleci
 outputs:
   - template: setup_workflow.yml.j2
@@ -439,7 +439,7 @@ Templates are stored in `.cigen/templates/`:
 
 ```
 .cigen/
-├── cigen.yml
+├── config.yml
 ├── templates/
 │   ├── setup_workflow.yml.j2      # Minimal template - just workflow structure
 │   ├── main_workflow.yml.j2       # Minimal template - just workflow structure
@@ -457,10 +457,10 @@ The templates only contain what makes each workflow unique - the cigen engine ha
 
 ### Docker Image Management
 
-Docker images are defined once in `cigen.yml` and referenced by logical names:
+Docker images are defined once in `config.yml` and referenced by logical names:
 
 ```yaml
-# cigen.yml
+# config.yml
 docker_images:
   ruby:
     default: cimg/ruby:3.3.5
diff --git a/notes/REQUIREMENTS.md b/notes/REQUIREMENTS.md
@@ -119,7 +119,7 @@ cigen already has minijinja integrated as the templating engine, which provides:
 cigen must support generating multiple output files from a single command:
 
 ```yaml
-# .cigen/cigen.yml
+# .cigen/config.yml
 outputs:
   - template: setup_config.yml.j2
     output: .circleci/config.yml
diff --git a/notes/SELF_HOSTING_ON_GITHUB_ACTIONS.md b/notes/SELF_HOSTING_ON_GITHUB_ACTIONS.md
diff --git a/src/commands/generate.rs b/src/commands/generate.rs
diff --git a/src/loader/config_loader.rs b/src/loader/config_loader.rs
diff --git a/src/validation/validator.rs b/src/validation/validator.rs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +jobs:
 +  fmt:
 +  clippy:
 +  test:
 +    requires:
 +      - fmt
 +      - clippy