Skip to content

Commit 19a2ef5

Browse files
committed
docs: document pkg.pr.new preview builds
1 parent f3a3374 commit 19a2ef5

1 file changed

Lines changed: 81 additions & 0 deletions

File tree

docs/guide/upgrade.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,84 @@ vp --version
7777
```
7878

7979
Then set the `vitest` override to that exact version, or rerun `vp migrate` to update the pin for you.
80+
81+
## Preview Builds
82+
83+
Some Vite+ pull requests publish temporary packages through `pkg.pr.new`. Treat these as nightly or bleeding-edge builds: they are useful when you want to verify a specific fix, test a fresh upstream dependency bump, or confirm a change before the next npm release. For day-to-day work, prefer the published `latest` release.
84+
85+
You can find preview builds in pull requests that automatically update upstream dependencies. For examples, search the merged pull requests for [upstream dependency updates](https://github.com/voidzero-dev/vite-plus/pulls?q=is%3Apr+is%3Amerged+upgrade+upstream+dependencies).
86+
87+
Preview builds are addressed by pull request number or commit SHA. They are not a stable version range, and you should avoid leaving them in long-lived branches unless a maintainer asks you to.
88+
89+
### Global `vp` Preview
90+
91+
Install a preview build of the global CLI by passing `VP_PR_VERSION` to the installer:
92+
93+
```bash
94+
curl -fsSL https://vite.plus | VP_PR_VERSION=<pr-or-sha> bash
95+
```
96+
97+
On Windows:
98+
99+
```powershell
100+
$env:VP_PR_VERSION = "<pr-or-sha>"
101+
irm https://vite.plus/ps1 | iex
102+
Remove-Item Env:\VP_PR_VERSION
103+
```
104+
105+
Run `vp --version` afterward to confirm which build and bundled tool versions are active. When you are done testing, return to the published release with `vp upgrade --force` or by running the installer again without `VP_PR_VERSION`.
106+
107+
### Local `vite-plus` Preview
108+
109+
To test an unreleased local package in a project, update the project dependency and any Vite+ alias or override before installing. Use the same pull request number or commit SHA for every preview URL:
110+
111+
- `vite-plus` should point at `https://pkg.pr.new/voidzero-dev/vite-plus@<pr-or-sha>`
112+
- any direct `vite` alias or direct `@voidzero-dev/vite-plus-core` dependency should point at `https://pkg.pr.new/voidzero-dev/vite-plus/@voidzero-dev/vite-plus-core@<pr-or-sha>`
113+
- any `vite` override or resolution should point at that same core preview URL
114+
115+
For npm and Bun projects, update the relevant `package.json` entries:
116+
117+
```json
118+
{
119+
"devDependencies": {
120+
"vite-plus": "https://pkg.pr.new/voidzero-dev/vite-plus@<pr-or-sha>",
121+
"vite": "https://pkg.pr.new/voidzero-dev/vite-plus/@voidzero-dev/vite-plus-core@<pr-or-sha>"
122+
},
123+
"overrides": {
124+
"vite": "https://pkg.pr.new/voidzero-dev/vite-plus/@voidzero-dev/vite-plus-core@<pr-or-sha>"
125+
}
126+
}
127+
```
128+
129+
Only include the direct `vite` entry if your project already has one. If your project has `@voidzero-dev/vite-plus-core` directly instead, update that package spec to the same core preview URL.
130+
131+
For pnpm workspaces, make the same temporary override change in `pnpm-workspace.yaml` if that is where your Vite+ overrides live:
132+
133+
```yaml
134+
overrides:
135+
vite: 'https://pkg.pr.new/voidzero-dev/vite-plus/@voidzero-dev/vite-plus-core@<pr-or-sha>'
136+
```
137+
138+
For Yarn projects, update `resolutions` instead:
139+
140+
```json
141+
{
142+
"resolutions": {
143+
"vite": "https://pkg.pr.new/voidzero-dev/vite-plus/@voidzero-dev/vite-plus-core@<pr-or-sha>"
144+
}
145+
}
146+
```
147+
148+
Then install once:
149+
150+
```bash
151+
vp install
152+
```
153+
154+
After installing a preview, check the bundled versions with `vp --version`. If the preview includes a newer bundled Vitest, update your `vitest` override to that exact version so `vp test` and project imports keep using the same Vitest copy.
155+
156+
When testing is complete, restore every preview spec first: set `vite-plus` back to `latest`, and set any direct `vite` / `@voidzero-dev/vite-plus-core` dependency plus any `vite` override or resolution back to `npm:@voidzero-dev/vite-plus-core@latest`. Then reinstall:
157+
158+
```bash
159+
vp install
160+
```

0 commit comments

Comments
 (0)