Skip to content

Commit 46ffbb7

Browse files
committed
docs(ci): enforce docs sync in CI
1 parent ab4b5dc commit 46ffbb7

3 files changed

Lines changed: 19 additions & 6 deletions

File tree

.github/workflows/rust-workspace-ci.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,18 @@ env:
1717
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
1818

1919
jobs:
20+
docs-sync:
21+
name: docs-sync
22+
runs-on: ubuntu-latest
23+
timeout-minutes: 10
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
- name: Install ripgrep
28+
run: sudo apt-get update && sudo apt-get install -y ripgrep
29+
- name: Check docs/code sync
30+
run: bash scripts/check-doc-sync.sh
31+
2032
rustfmt:
2133
name: rustfmt
2234
runs-on: ubuntu-latest

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ cargo animus-fmt-check
8181
# Lint check
8282
cargo animus-lint
8383

84+
# Docs/code sync check
85+
npm run docs:check-sync
86+
8487
# Test all crates
8588
cargo test --workspace
8689
```

docs/guides/ci-cd.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ Animus uses GitHub Actions for continuous integration and release automation. Th
66

77
### Rust Workspace CI (`rust-workspace-ci.yml`)
88

9-
Runs on every push and pull request. Checks the workspace and lints with `-D warnings`:
9+
Runs on every push and pull request. The current jobs are:
1010

11+
- `bash scripts/check-doc-sync.sh` fails fast when `docs/reference/cli/index.md`, `docs/reference/mcp-tools.md`, `docs/guides/agents.md`, and the count-sensitive docs drift from the live Rust surface.
12+
- `cargo fmt --all -- --check` enforces Rust formatting.
1113
- `cargo check --workspace --all-targets` covers every crate (runtime-critical and otherwise) in one cached job — no per-crate matrix to drift against this doc.
1214
- `cargo clippy --workspace --all-targets -- -D warnings` gates every PR on a clean strict lint (the same gate `cargo animus-lint-strict` runs locally).
13-
- `cargo test --workspace` for the full test suite.
15+
- `cargo run --locked -p orchestrator-cli --bin animus -- --help` provides a final smoke check after the workspace compiles.
1416
- Concurrency grouping cancels superseded runs on the same branch.
1517

1618
### Rust-Only Dependency Policy (`rust-only-dependency-policy.yml`)
@@ -23,10 +25,6 @@ The web UI now lives in the external `launchapp-dev/animus-web-ui` repository
2325
and ships its own CI. The Animus monorepo no longer builds or tests the
2426
web bundle.
2527

26-
### Release Rollback Validation (`release-rollback-validation.yml`)
27-
28-
Validates that release artifacts can be produced correctly and that the release process is reversible.
29-
3028
## Build Commands
3129

3230
Animus provides cargo aliases for building the release CLI package:

0 commit comments

Comments
 (0)