Docs: fix build #2058
Docs: fix build #2058
Conversation
|
Deploying openapi-ts with
|
| Latest commit: |
f2dfe09
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://336c99ea.openapi-ts.pages.dev |
| Branch Preview URL: | https://fix-docs.openapi-ts.pages.dev |
size-limit report 📦
|
| @@ -4,13 +4,14 @@ | |||
| "private": true, | |||
| "type": "module", | |||
| "scripts": { | |||
| "build-docs": "pnpm run update-contributors && vitepress build && cp _redirects .vitepress/dist", | |||
| "build-docs": "pnpm run update-contributors && pnpm run -w build && vitepress build && cp _redirects .vitepress/dist", | |||
There was a problem hiding this comment.
@kerwanp Probably worth explaining this weird little quirk of docs:
- Turborepo will just run the
buildscript in every package. We recommend contributors do this when setting up the project locally - However, because we have our contributors list pulling from GitHub, we need an API token to pull this data
- To fix this, either we require everyone to have a GitHub API token (annoying), or we just make the docs build a different command (less annoying)
- Because the docs command is intentionally different, this means it runs at different times than the build
- The docs before didn’t need a build of all packages, so we just skipped it. But since that’s now a requirement, we’ll just build as part of the docs.
This may add a tiny bit of delay to the docs, but the monorepo builds really quickly, so it’s better to just build everything than try and surgically determine the minimal build. It’s always a balance of “what’s efficient compute-wise” and “what’s easiest to work with people-wise” and it’s always good to try and satisfy both reasonably.
drwpow
force-pushed
the
fix-docs
branch
2 times, most recently
from
d6411b1 to
a9f6594
Compare
|
|
||
| export default defineConfig({ | ||
| plugins: [react()], | ||
| plugins: [react() as unknown as Plugin], |
There was a problem hiding this comment.
Ugh this weird type issue is back :/ I feel like this comes and goes a lot
|
If it’s alright, I’m just going to force this through without approval because it doesn’t change anything; just unblocks the docs deploy |
Changes
Adds a
pnpm run -w buildto build all packages for docs.How to Review
Checklist
N/A