Skip to content

Commit ee9c48f

Browse files
feat: API sidebar sync automation (#367)
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent b55b787 commit ee9c48f

File tree

5 files changed

+514
-19
lines changed

5 files changed

+514
-19
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ jobs:
4040
echo "No usage of support@glean.com found"
4141
fi
4242
43+
- name: Check API sidebar completeness
44+
run: pnpm sidebar:check
45+
4346
- name: Build website
4447
run: pnpm build
4548
env:

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,11 @@
4141
"format:check": "prettier --check .",
4242
"links:check": "scripts/check-links.sh https://developers.glean.com true",
4343
"links:check:local": "pnpm build && (pnpm serve --port 8888 & SERVER_PID=$!; sleep 5; scripts/check-links.sh http://localhost:8888 true; RESULT=$?; kill $SERVER_PID 2>/dev/null || true; exit $RESULT)",
44-
"openapi:regenerate:all": "pnpm run openapi:clean:before:all && pnpm run openapi:transform:all && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:all && pnpm run openapi:clean:after:all",
45-
"openapi:regenerate:client": "pnpm run openapi:clean:before:client && pnpm run openapi:transform:client && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:client && pnpm run openapi:clean:after:client",
46-
"openapi:regenerate:indexing": "pnpm run openapi:clean:before:indexing && pnpm run openapi:transform:indexing && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:indexing && pnpm run openapi:clean:after:indexing",
44+
"sidebar:check": "node scripts/sync-api-sidebar.mjs --check",
45+
"sidebar:fix": "node scripts/sync-api-sidebar.mjs --fix",
46+
"openapi:regenerate:all": "pnpm run openapi:clean:before:all && pnpm run openapi:transform:all && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:all && pnpm run openapi:clean:after:all && pnpm run sidebar:fix",
47+
"openapi:regenerate:client": "pnpm run openapi:clean:before:client && pnpm run openapi:transform:client && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:client && pnpm run openapi:clean:after:client && pnpm run sidebar:fix",
48+
"openapi:regenerate:indexing": "pnpm run openapi:clean:before:indexing && pnpm run openapi:transform:indexing && pnpm run generate:deprecations && pnpm run generate:deprecations:rss && pnpm run openapi:generate:indexing && pnpm run openapi:clean:after:indexing && pnpm run sidebar:fix",
4749
"openapi:clean:before:all": "pnpm run openapi:clean:before:client && pnpm run openapi:clean:before:indexing",
4850
"openapi:clean:before:client": "find docs/api/client-api -type f ! -name 'overview.mdx' -delete",
4951
"openapi:clean:before:indexing": "find docs/api/indexing-api -type f ! -name '*-overview.mdx' -delete",
@@ -134,6 +136,7 @@
134136
"@vitest/ui": "^4.0.18",
135137
"fast-levenshtein": "^3.0.0",
136138
"fixturify-project": "^7.1.3",
139+
"jscodeshift": "^17.3.0",
137140
"jsdom": "^27.4.0",
138141
"nock": "^14.0.0",
139142
"npm-run-all": "^4.1.5",

0 commit comments

Comments
 (0)