auto generate kernel-builder cli docs. (#463)

* auto generate kernel-builder cli docs.

* fixes

* fix to shas

* address review feedback

Author: sayakpaul

.github/workflows/kernel-builder-cli-docs.yaml

@@ -0,0 +1,45 @@
+name: Check CLI docs are up to date
+
+on:
+  pull_request:
+    paths:
+      - "kernel-builder/src/**"
+      - "kernel-builder/Cargo.toml"
+      - "docs/source/builder-cli.md"
+      - "Makefile"
+      - ".github/workflows/kernel-builder-cli-docs.yaml"
+  push:
+    branches:
+      - main
+
+jobs:
+  check-cli-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8  # stable
+
+      - name: Cache cargo registry and build
+        uses: actions/cache@a7833574556fa59680c1b7cb190c1735db73ebf0  # v5.0.0
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-cli-docs-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-cli-docs-
+
+      - name: Generate CLI docs
+        run: make kernel-builder-cli-docs
+
+      - name: Check docs are up to date
+        run: |
+          if ! git diff --quiet docs/source/builder-cli.md; then
+            echo "::error::builder-cli.md is out of date. Run 'make kernel-builder-cli-docs' to regenerate."
+            git diff docs/source/builder-cli.md
+            exit 1
+          fi
+          echo "CLI docs are up to date."

Cargo.lock

@@ -1,4 +1,4 @@
-.PHONY: style
+.PHONY: style kernel-builder-cli-docs
 
 export check_dirs := kernels/src kernels/tests
 
@@ -11,3 +11,12 @@ style:
 	black ${check_dirs}
 	isort ${check_dirs}
 	ruff check ${check_dirs} --fix
+
+kernel-builder-cli-docs:
+	cargo build -p hf-kernel-builder
+	./target/debug/kernel-builder generate-docs \
+	  | sed 's/hf-kernel-builder/kernel-builder/g' \
+	  | sed '1s/^# Command-Line Help for `kernel-builder`/# CLI reference for kernel-builder/' \
+	  | sed '/`--backends/,/^\*/{/^  Default value:/d;}' \
+	  > docs/source/builder-cli.md
+	@echo "Generated docs/source/builder-cli.md"

Makefile

@@ -67,4 +67,6 @@
       title: kernels download
     - local: cli-skills
       title: kernel-builder skills
+    - local: builder-cli
+      title: Builder CLI Reference
   title: CLI Reference