ci: add docs build workflow#135
Merged
hydroroll-bot merged 5 commits intoHydroRoll-Team:mainfrom Apr 1, 2026
Merged
Conversation
|
@NtskwK is attempting to deploy a commit to the retrofor Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Reviewer's GuideAdds a GitHub Actions workflow that builds the docs package on relevant pushes, pull requests, and manual triggers using pnpm and Node 22. Flow diagram for docs build job stepsflowchart TD
A[Start Docs Build Check workflow] --> B{Event type}
B -->|push to main/dev with changes in packages/docs| C[Run build job on ubuntu-latest]
B -->|pull_request to main with changes in packages/docs| C
B -->|workflow_dispatch| C
C --> D[Checkout code using actions/checkout@v6]
D --> E[Install pnpm using pnpm/action-setup@v4]
E --> F[Install Node.js 22 using actions/setup-node@v4 with pnpm cache]
F --> G[Run pnpm install]
G --> H[Run pnpm build in packages/docs]
H --> I[Docs build completes]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- Consider pinning the GitHub Actions (checkout, pnpm/action-setup, setup-node) to specific commit SHAs instead of major tags to improve supply-chain security and reproducibility.
- Using
pnpm install --frozen-lockfile(or the stricter equivalent for your setup) instead of plainpnpm installwould help ensure the docs build uses the exact dependency set defined in the lockfile. - If the project standardizes on an LTS Node.js version, you may want to align the
node-versionhere with that LTS rather than hard-coding22to avoid unexpected incompatibilities.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider pinning the GitHub Actions (checkout, pnpm/action-setup, setup-node) to specific commit SHAs instead of major tags to improve supply-chain security and reproducibility.
- Using `pnpm install --frozen-lockfile` (or the stricter equivalent for your setup) instead of plain `pnpm install` would help ensure the docs build uses the exact dependency set defined in the lockfile.
- If the project standardizes on an LTS Node.js version, you may want to align the `node-version` here with that LTS rather than hard-coding `22` to avoid unexpected incompatibilities.
## Individual Comments
### Comment 1
<location path=".github/workflows/docs-build.yml" line_range="36-37" />
<code_context>
+ cache: "pnpm"
+ cache-dependency-path: "pnpm-lock.yaml"
+
+ - name: Install Dependencies
+ run: pnpm install
+
+ - name: Build Docs
</code_context>
<issue_to_address>
**suggestion:** Use a lockfile-respecting install to ensure deterministic dependency resolution
Using plain `pnpm install` in CI can mutate the lockfile or resolve dependencies differently between runs. To keep builds deterministic and fail fast when `pnpm-lock.yaml` is out of sync, use a strict/lockfile-only install (e.g. `pnpm install --frozen-lockfile`).
```suggestion
- name: Install Dependencies
run: pnpm install --frozen-lockfile
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow to ensure the packages/docs site builds successfully in CI, helping catch docs build regressions early.
Changes:
- Introduces a new
Docs Build Checkworkflow triggered on docs-path changes for pushes and PRs. - Sets up Node.js + pnpm, installs workspace dependencies, and runs the docs build.
HsiangNianian
approved these changes
Apr 1, 2026
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
hydroroll-bot
approved these changes
Apr 1, 2026
Member
hydroroll-bot
left a comment
There was a problem hiding this comment.
LGTM,工作流配置合理,使用了最新的 actions 版本,缓存和触发条件都设置得当
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by Sourcery
CI: