MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-05-12 21:03:05 -07:00
Code Issues Packages Projects Releases Wiki Activity

chore(ci): enforce settings docs parity in preflight

Browse Source 
Add a dedicated check:docs:settings script and run it from preflight to catch settings doc drift locally before CI.

Update GEMINI.md testing guidance to include the new CI-parity check for CLI/UI changes.
This commit is contained in:
Dmitry Lyalin
2026-02-16 11:08:59 -05:00
parent bb7bb11736
commit 223d448575
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
GEMINI.md
+5 -1
View File
@@ -47,8 +47,12 @@ powerful tool for developers.
be relative to the workspace root, e.g., be relative to the workspace root, e.g.,
`-w @google/gemini-cli-core -- src/routing/modelRouterService.test.ts`) `-w @google/gemini-cli-core -- src/routing/modelRouterService.test.ts`)
- **Full Validation:** `npm run preflight` (Heaviest check; runs clean, install, - **Full Validation:** `npm run preflight` (Heaviest check; runs clean, install,
build, lint, type check, and tests. Recommended before submitting PRs.) build, settings docs verification, lint, type check, and tests. Recommended
before submitting PRs.)
- **Individual Checks:** `npm run lint` / `npm run format` / `npm run typecheck` - **Individual Checks:** `npm run lint` / `npm run format` / `npm run typecheck`
- **CI-Parity Checks for CLI/UI changes:** Run these before pushing:
`npm run test:ci --workspace @google/gemini-cli` and
`npm run check:docs:settings`.
## Development Conventions ## Development Conventions
package.json
+2 -1
View File
@@ -28,6 +28,7 @@
"auth": "npm run auth:npm && npm run auth:docker", "auth": "npm run auth:npm && npm run auth:docker",
"generate": "node scripts/generate-git-commit-info.js", "generate": "node scripts/generate-git-commit-info.js",
"predocs:settings": "npm run build --workspace @google/gemini-cli-core", "predocs:settings": "npm run build --workspace @google/gemini-cli-core",
"check:docs:settings": "npm run predocs:settings && npm run docs:settings -- --check",
"schema:settings": "tsx ./scripts/generate-settings-schema.ts", "schema:settings": "tsx ./scripts/generate-settings-schema.ts",
"docs:settings": "tsx ./scripts/generate-settings-doc.ts", "docs:settings": "tsx ./scripts/generate-settings-doc.ts",
"docs:keybindings": "tsx ./scripts/generate-keybindings-doc.ts", "docs:keybindings": "tsx ./scripts/generate-keybindings-doc.ts",
@@ -54,7 +55,7 @@
"lint:all": "node scripts/lint.js", "lint:all": "node scripts/lint.js",
"format": "prettier --experimental-cli --write .", "format": "prettier --experimental-cli --write .",
"typecheck": "npm run typecheck --workspaces --if-present", "typecheck": "npm run typecheck --workspaces --if-present",
"preflight": "npm run clean && npm ci && npm run format && npm run build && npm run lint:ci && npm run typecheck && npm run test:ci", "preflight": "npm run clean && npm ci && npm run format && npm run build && npm run check:docs:settings && npm run lint:ci && npm run typecheck && npm run test:ci",
"prepare": "husky && npm run bundle", "prepare": "husky && npm run bundle",
"prepare:package": "node scripts/prepare-package.js", "prepare:package": "node scripts/prepare-package.js",
"release:version": "node scripts/version.js", "release:version": "node scripts/version.js",