Skip to content

fix(ci): align docs formatter with checkout#2178

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

Closed
wan9chi wants to merge 1 commit into from
Closed

fix(ci): align docs formatter with checkout #2178

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
29 changes: 21 additions & 8 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,19 +82,32 @@ jobs:

- uses: voidzero-dev/setup-vp@13e7afb99c66525824db54e107d667216e795d37 # v1.14.0
with:
# The workspace `vite-plus` version can be ahead of the registry, so
# pin the released build instead of auto-detecting from package.json.
# Install the released package to evaluate `vite.config.ts` without a
# full workspace install. The formatter itself is pinned below to the
# version used by this checkout.
version: latest
run-install: false

- name: Run vp fmt --check
- name: Run oxfmt --check
run: |
# `vp fmt` loads the root vite.config.ts, whose `import ... from 'vite-plus'`
# must resolve at runtime. Link the released package out of the global
# install instead of installing the whole workspace.
mkdir -p node_modules
oxfmt_version="$(awk '$1 == "oxfmt:" { sub(/^=/, "", $2); print $2; exit }' pnpm-workspace.yaml)"
if [[ -z "$oxfmt_version" ]]; then
echo "::error::Could not resolve the workspace oxfmt version"
exit 1
fi

# Keep this job lightweight while using the same formatter version as
# code CI. Oxfmt needs `vite-plus` beside both its CLI and the generated
# config module in order to load the root `fmt` configuration.
oxfmt_dir="$RUNNER_TEMP/docs-fmt-oxfmt"
mkdir -p "$oxfmt_dir" node_modules
pnpm --dir "$oxfmt_dir" add --save-exact "oxfmt@$oxfmt_version"

@chatgpt-codex-connectorchatgpt-codex-connectorBotJul 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Install oxfmt through a provisioned package manager

In docs-only runs this job has only checkout + setup-vp before this step; it does not run setup-node/pnpm. setup-vp installs Vite+ and its env setup only creates node, npm, npx, corepack, vpx, and vpr shims (SHIM_TOOLS in crates/vite_global_cli/src/commands/env/setup.rs), not pnpm; the GitHub Ubuntu runner image also lists npm/yarn but not pnpm as preinstalled. As a result pnpm --dir ... add can be command not found and the docs formatter job fails before checking docs. Use corepack pnpm, vp's package-manager path, or add an explicit pnpm setup.

Useful? React with 👍 / 👎.

ln -s "$HOME/.vite-plus/current/node_modules/vite-plus" "$oxfmt_dir/node_modules/vite-plus"
ln -s "$HOME/.vite-plus/current/node_modules/vite-plus" node_modules/vite-plus
vp fmt --check

VP_VERSION="$(node -p "require(process.env.HOME + '/.vite-plus/current/node_modules/vite-plus/package.json').version")" \
VP_RESOLVING_CONFIG_METADATA=1 \
"$oxfmt_dir/node_modules/.bin/oxfmt" --check --disable-nested-config

download-previous-rolldown-binaries:
needs: detect-changes
Expand Down
Loading