Skip to content

fix(FR-2906): invoke docs-toolkit CLI by node path so build_docs survives pnpm v11 bin-link gap #7441

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

Open
yomybaby wants to merge 1 commit into
base: main
Choose a base branch
from
+37 −48
Open

fix(FR-2906): invoke docs-toolkit CLI by node path so build_docs survives pnpm v11 bin-link gap #7441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 0 additions & 11 deletions .github/workflows/package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,17 +242,6 @@ jobs:
- name: Install Dependencies
run: pnpm install --frozen-lockfile

# backend.ai-docs-toolkit ships its `docs-toolkit` CLI as the package
# bin, but it lives at dist/cli.js which only exists after `tsc` runs.
# On a fresh `pnpm install` the dist directory is empty, so pnpm
# cannot create the .bin/docs-toolkit symlink and later `pdf:all`
# fails with `spawn ENOENT`. Building the toolkit and re-running
# install populates dist/ and lets pnpm wire the bin link.
- name: Build docs-toolkit and link CLI
run: |
pnpm --filter backend.ai-docs-toolkit run build
pnpm install --frozen-lockfile

# Cache the Playwright browser binaries (~150 MB Chromium download).
# The lockfile hash keys the cache so a Playwright version bump
# naturally invalidates the cache without manual intervention.
Expand Down
18 changes: 9 additions & 9 deletions packages/backend.ai-docs-toolkit-example/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
"description": "Minimal example/boilerplate project for backend.ai-docs-toolkit. Doubles as the test fixture for the toolkit's integration tests.",
"scripts": {
"build:toolkit": "pnpm --filter backend.ai-docs-toolkit build",
"build:web": "pnpm run build:toolkit && docs-toolkit build:web --lang all",
"build:web:en": "pnpm run build:toolkit && docs-toolkit build:web --lang en",
"build:web:ko": "pnpm run build:toolkit && docs-toolkit build:web --lang ko",
"pdf": "pnpm run build:toolkit && docs-toolkit pdf --lang all",
"pdf:en": "pnpm run build:toolkit && docs-toolkit pdf --lang en",
"pdf:ko": "pnpm run build:toolkit && docs-toolkit pdf --lang ko",
"preview": "pnpm run build:toolkit && docs-toolkit preview --mode document --lang en",
"serve:web": "pnpm run build:toolkit && docs-toolkit serve:web --lang en",
"serve:web:ko": "pnpm run build:toolkit && docs-toolkit serve:web --lang ko",
"build:web": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang all",
"build:web:en": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang en",
"build:web:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang ko",
"pdf": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang all",
"pdf:en": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang en",
"pdf:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang ko",
"preview": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode document --lang en",
"serve:web": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang en",
"serve:web:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang ko",
"test": "pnpm run test:pdf && pnpm run test:e2e",
"test:e2e": "playwright test --config tests/web/playwright.config.ts",
"test:pdf": "tsx --test tests/pdf/*.test.ts"
Expand Down
56 changes: 28 additions & 28 deletions packages/backend.ai-webui-docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,34 @@
"type": "module",
"scripts": {
"build:toolkit": "pnpm --filter backend.ai-docs-toolkit build",
"pdf": "pnpm run build:toolkit && docs-toolkit pdf --lang all",
"pdf:en": "pnpm run build:toolkit && docs-toolkit pdf --lang en",
"pdf:ko": "pnpm run build:toolkit && docs-toolkit pdf --lang ko",
"pdf:ja": "pnpm run build:toolkit && docs-toolkit pdf --lang ja",
"pdf:th": "pnpm run build:toolkit && docs-toolkit pdf --lang th",
"pdf:all": "pnpm run build:toolkit && docs-toolkit pdf --lang all",
"preview": "pnpm run build:toolkit && docs-toolkit preview --mode sample",
"preview:catalog": "pnpm run build:toolkit && docs-toolkit preview --mode catalog",
"preview:doc": "pnpm run build:toolkit && docs-toolkit preview --mode document --lang en",
"preview:doc:ko": "pnpm run build:toolkit && docs-toolkit preview --mode document --lang ko",
"preview:doc:ja": "pnpm run build:toolkit && docs-toolkit preview --mode document --lang ja",
"preview:doc:th": "pnpm run build:toolkit && docs-toolkit preview --mode document --lang th",
"preview:html": "pnpm run build:toolkit && docs-toolkit preview:html --lang en",
"preview:html:ko": "pnpm run build:toolkit && docs-toolkit preview:html --lang ko",
"preview:html:ja": "pnpm run build:toolkit && docs-toolkit preview:html --lang ja",
"preview:html:th": "pnpm run build:toolkit && docs-toolkit preview:html --lang th",
"preview:html:catalog": "pnpm run build:toolkit && docs-toolkit preview:html --mode catalog",
"build:web": "pnpm run build:toolkit && docs-toolkit build:web --lang all",
"build:web:en": "pnpm run build:toolkit && docs-toolkit build:web --lang en",
"build:web:ko": "pnpm run build:toolkit && docs-toolkit build:web --lang ko",
"build:web:optimized": "pnpm run build:toolkit && docs-toolkit build:web --lang all --optimize-images",
"build:web:en:optimized": "pnpm run build:toolkit && docs-toolkit build:web --lang en --optimize-images",
"serve:web": "pnpm run build:toolkit && docs-toolkit serve:web --lang en",
"serve:web:ko": "pnpm run build:toolkit && docs-toolkit serve:web --lang ko",
"serve:web:ja": "pnpm run build:toolkit && docs-toolkit serve:web --lang ja",
"serve:web:th": "pnpm run build:toolkit && docs-toolkit serve:web --lang th",
"agents": "docs-toolkit agents",
"agents:force": "docs-toolkit agents --force"
"pdf": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang all",
"pdf:en": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang en",
"pdf:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang ko",
"pdf:ja": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang ja",
"pdf:th": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang th",
"pdf:all": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js pdf --lang all",
"preview": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode sample",
"preview:catalog": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode catalog",
"preview:doc": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode document --lang en",
"preview:doc:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode document --lang ko",
"preview:doc:ja": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode document --lang ja",
"preview:doc:th": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview --mode document --lang th",
"preview:html": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview:html --lang en",
"preview:html:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview:html --lang ko",
"preview:html:ja": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview:html --lang ja",
"preview:html:th": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview:html --lang th",
"preview:html:catalog": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js preview:html --mode catalog",
"build:web": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang all",
"build:web:en": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang en",
"build:web:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang ko",
"build:web:optimized": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang all --optimize-images",
"build:web:en:optimized": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js build:web --lang en --optimize-images",
"serve:web": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang en",
"serve:web:ko": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang ko",
"serve:web:ja": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang ja",
"serve:web:th": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js serve:web --lang th",
"agents": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js agents",
"agents:force": "pnpm run build:toolkit && node ../backend.ai-docs-toolkit/dist/cli.js agents --force"
},
"devDependencies": {
"backend.ai-docs-toolkit": "workspace:*",
Expand Down
Loading