Skip to content

feat: API sidebar sync automation #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steve-calvert-glean merged 4 commits into from
Feb 27, 2026
+514 −19
Merged

feat: API sidebar sync automation #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e13da2e
feat: add API sidebar sync script and CI gate
steve-calvert-glean Feb 27, 2026
525f1a2
fix(sidebar): add missing client API entries via sidebar:fix
steve-calvert-glean Feb 27, 2026
3948813
style: apply prettier formatting to sync-api-sidebar.mjs
steve-calvert-glean Feb 27, 2026
83c0555
refactor: use node:util parseArgs for CLI argument parsing
steve-calvert-glean Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ jobs:
echo "No usage of support@glean.com found"
fi

- name: Check API sidebar completeness
run: pnpm sidebar:check

- name: Build website
run: pnpm build
env:
Expand Down
9 changes: 6 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@
"format:check": "prettier --check .",
"links:check": "scripts/check-links.sh https://developers.glean.com true",
"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)",
"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",
"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",
"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",
"sidebar:check": "node scripts/sync-api-sidebar.mjs --check",
"sidebar:fix": "node scripts/sync-api-sidebar.mjs --fix",
"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",
"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",
"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",
"openapi:clean:before:all": "pnpm run openapi:clean:before:client && pnpm run openapi:clean:before:indexing",
"openapi:clean:before:client": "find docs/api/client-api -type f ! -name 'overview.mdx' -delete",
"openapi:clean:before:indexing": "find docs/api/indexing-api -type f ! -name '*-overview.mdx' -delete",
Expand Down Expand Up @@ -134,6 +136,7 @@
"@vitest/ui": "^4.0.18",
"fast-levenshtein": "^3.0.0",
"fixturify-project": "^7.1.3",
"jscodeshift": "^17.3.0",
"jsdom": "^27.4.0",
"nock": "^14.0.0",
"npm-run-all": "^4.1.5",
Expand Down
Loading