ci(workflow): deploy rustdocs for turbopack #61958
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kwonoj
force-pushed
the
turbopack-docs-deploy
branch
5 times, most recently
from
5274114
to
22e8e97
Compare
Tests Passed |
Stats from current PRDefault BuildGeneral
Client Bundles (main, webpack)
Legacy Client Bundles (polyfills)
Client Pages
Client Build Manifests
Rendered Page Sizes
Edge SSR bundle Size
Middleware size
Next Runtimes
|
kwonoj
force-pushed
the
turbopack-docs-deploy
branch
2 times, most recently
from
61eec16
to
f0972ee
Compare
kwonoj
requested review from
timneutkens,
ijjk,
shuding,
huozhi and
a team
as code owners
kwonoj
requested review from
manovotny and
molebox
and removed request for
a team
kwonoj
added a commit
to vercel/turbo
that referenced
this pull request
Feb 12, 2024
### Description To replaced by vercel/next.js#61958 Closes PACK-2470
Comment on lines
+5
to
+7
| Currently it's work in progress, the only package available is [Turbo tasks-fs](turbo_tasks_fs/index.html) | ||
|
|
||
| [comment]: # 'Temporary index page document' |
There was a problem hiding this comment.
It's a markdown comment. Will go away when updating docs.
There was a problem hiding this comment.
To explicitly state index is work in progress temporary, just to render content. Could be a visible to the rendered page, in any case would like to note for anyone see this.
| fi | ||
| fi | ||
|
|
||
| RUSTDOCFLAGS="-Z unstable-options --index-page $(pwd)/packages/next-swc/docs/index.md" cargo doc -p turbo-tasks-fs --no-deps |
There was a problem hiding this comment.
only pkg I can casually find to build with rustdoc without 1. huge time to check CI 2. does not actually raises build error.
There was a problem hiding this comment.
I don't see the point in adding this just for turbo-tasks-fs
There was a problem hiding this comment.
yes, there's no point for doc itself. It's setup that ensures
- we can build cargo docs without build error
- we can deploy it correctly.
It's just starting point to actually add docs.
| - name: Install Rust | ||
| uses: ./.github/actions/setup-rust | ||
| - name: Deploy preview docs | ||
| if: ${{ needs.build.outputs.isRelease != 'true' }} |
There was a problem hiding this comment.
this could just be a ternary on DEPLOY_ENVIRONMENT
There was a problem hiding this comment.
Could be, but same as the script itself this mimics pattern setup in other deploy work - making it consistent so later easy to find & replace as needed.
There was a problem hiding this comment.
just because the existing code is bad doesn't mean the new code has to be as well
There was a problem hiding this comment.
is it bad though? I honestly don't think it's that bad, especially isRelease is universal flag for all of the existing next.js CI's workflow to work with release. It might be different way, but I don't see reason to try other pattern over established pattern.
kwonoj
force-pushed
the
turbopack-docs-deploy
branch
from
f0972ee
to
5c2df9f
Compare
wbinnssmith
approved these changes
Feb 12, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
We'd like to deploy generated rustdocs from turbopack & related packages (next-swc), setting up a CI workflow to automate those.
Since we need next.js side packages to build docs, this CI sets up things in this repo.
Closes PACK-2375.