Skip to content

Commit 108c81c

Browse files
committed
ref(docs): Move CLI command validation to review skill
Remove the automated docs:check script from CI, pre-commit, release, and project guidance. Use a dedicated review skill for changelog CLI command references instead, so historical migration examples can be judged with context.
1 parent 7d550ad commit 108c81c

12 files changed

Lines changed: 73 additions & 222 deletions

File tree

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: xcodebuildmcp-docs-command-review
3+
description: Use when reviewing XcodeBuildMCP changelog CLI command references for invalid current guidance while allowing historical migration examples.
4+
allowed-tools: Read Grep Glob
5+
---
6+
7+
# XcodeBuildMCP Docs Command Review
8+
9+
Review changed changelog entries for CLI command references that would mislead users or agents.
10+
11+
## What to inspect
12+
13+
- `CHANGELOG.md`
14+
- `manifests/tools/*.yaml` and `manifests/workflows/*.yaml` when you need to verify current CLI workflow/tool names
15+
- `src/cli/**` only when command wiring is unclear from manifests
16+
17+
## Issue criteria
18+
19+
Report a finding only when a command reference is presented as current guidance and appears invalid for the current CLI surface.
20+
21+
### High severity
22+
23+
- A changelog bullet, example, or migration instruction tells users to run a removed or invalid `xcodebuildmcp` command as the current path.
24+
- A Breaking change mentions a removed command but does not give a valid replacement.
25+
- A command reference uses the wrong workflow/tool pairing in a way a user or agent would likely copy.
26+
27+
### Medium severity
28+
29+
- A command reference is ambiguous enough that users may not know whether it is historical or current.
30+
- A migration example gives the right replacement but does not clearly label the old command as "Before", "old", "removed", or equivalent.
31+
32+
## Explicitly allowed
33+
34+
Do not report removed commands when they are clearly historical context, especially in:
35+
36+
- Breaking-change migration sections
37+
- "Before" examples paired with valid "After" examples
38+
- Already-released changelog sections describing past behavior
39+
40+
Example that should not be reported:
41+
42+
```markdown
43+
Before:
44+
xcodebuildmcp logging start-sim-log-cap
45+
46+
After:
47+
xcodebuildmcp simulator build-and-run
48+
```
49+
50+
## Output
51+
52+
For each finding, include:
53+
54+
- Severity
55+
- File and line
56+
- The command reference
57+
- Why it reads as current guidance
58+
- Suggested replacement wording or command
59+
60+
If all command references are historical or valid, report no findings.

.agents/skills/xcodebuildmcp-docs-release-review/SKILL.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Review guardrails for documentation, generated references, and release flow cons
1616

1717
- `README.md`
1818
- `CHANGELOG.md` when present
19-
- `scripts/check-docs-cli-commands.js`
2019
- `scripts/build-website-manifest.mjs`
2120
- `scripts/generate-github-release-notes.mjs`
2221
- `scripts/release.sh`
@@ -33,11 +32,11 @@ Review guardrails for documentation, generated references, and release flow cons
3332
- Website manifest generation preserves expected normalized fields.
3433
- Docs explain runtime/contracts without deprecated patterns.
3534
- Keep docs-only work from introducing product behavior changes.
35+
- CLI command references in changelog entries are reviewed by `xcodebuildmcp-docs-command-review`.
3636

3737
## Validation
3838

3939
- `npm run build`
40-
- `npm run docs:check`
4140
- Release notes check when touched:
4241
- `node scripts/generate-github-release-notes.mjs --version <version> --changelog CHANGELOG.md`
4342
- `npx skill-check .agents/skills/xcodebuildmcp-docs-release-review`

.agents/skills/xcodebuildmcp-packaging-resource-review/SKILL.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ Review guardrails for package/build/resource integrity and portable distribution
3737
## Validation
3838

3939
- `npm run build`
40-
- `npm run docs:check`
4140
- Packaging-specific when touched:
4241
- `npm run package:macos -- --help` (if supported)
4342
- `npm run verify:portable` after artifact creation

.agents/skills/xcodebuildmcp-runtime-boundary-review/SKILL.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,4 @@ Review guardrails for runtime routing and invocation boundaries.
3838

3939
- `npm test -- src/runtime/__tests__/tool-invoker.test.ts`
4040
- `npm run typecheck`
41-
- `npm run docs:check`
4241
- `npx skill-check .agents/skills/xcodebuildmcp-runtime-boundary-review`

.agents/skills/xcodebuildmcp-tool-contract-review/SKILL.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ Review guardrails for tool contract changes across implementation, manifests, an
3737

3838
## Validation
3939

40-
- `npm run docs:check`
4140
- `npm run typecheck`
4241
- `npm test -- src/core/manifest/__tests__/schema.test.ts`
4342
- `npm test -- src/runtime/__tests__/tool-invoker.test.ts`

.githooks/pre-commit

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,4 @@ if [ $? -ne 0 ]; then
2727
exit 1
2828
fi
2929

30-
if [ "${XCODEBUILDMCP_DOCS_CHECK_WARN_ONLY:-}" = "1" ]; then
31-
echo "Validating CLI command references in consumer docs (warnings only)..."
32-
node scripts/check-docs-cli-commands.js --warn-only
33-
else
34-
echo "Validating CLI command references in consumer docs..."
35-
npm run docs:check
36-
if [ $? -ne 0 ]; then
37-
echo "${RED}Docs command validation failed. Aborting commit.${NC}"
38-
exit 1
39-
fi
40-
fi
41-
4230
echo "Pre-commit checks passed."

.github/workflows/ci.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ jobs:
3232
- name: Build
3333
run: npm run build
3434

35-
- name: Validate docs CLI command references
36-
run: npm run docs:check
37-
3835
- name: Lint
3936
run: npm run lint
4037

AGENTS.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- `npm run lint` / `npm run lint:fix` - ESLint
88
- `npm run format` / `npm run format:check` - Prettier
99
- `npm run typecheck` - TypeScript type checking (src + test config)
10-
- `npm run docs:check` - Validate docs match CLI surface
1110

1211
## Architecture
1312
ESM TypeScript project (`type: module`). Key layers:
@@ -34,7 +33,6 @@ ESM TypeScript project (`type: module`). Key layers:
3433
npm run typecheck
3534
npm run format
3635
npm run build
37-
npm run docs:check
3836
npm test
3937
```
4038
4. Update `CHANGELOG.md` under `## [Unreleased]`

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
"typecheck:tests": "npx tsc -p tsconfig.test.json",
3939
"inspect": "npx @modelcontextprotocol/inspector@latest node build/cli.js mcp",
4040
"doctor": "node build/doctor-cli.js",
41-
"docs:check": "node scripts/check-docs-cli-commands.js",
4241
"bench:test-sim": "npx tsx scripts/benchmark-simulator-test.ts",
4342
"capture:xcodebuild": "npx tsx scripts/capture-xcodebuild-wrapper.ts",
4443
"license:report": "node scripts/generate-third-party-package-licenses.mjs",

scripts/check-docs-cli-commands.js

Lines changed: 0 additions & 189 deletions
This file was deleted.

0 commit comments

Comments
 (0)