Improve docs for preview builds (#67422)

Builds can now be addressed by PR number.
This commit is contained in:
Sebastian Silbermann 2024-07-05 13:12:41 +02:00 committed by GitHub
parent 199b869d5b
commit f49506703e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -130,17 +130,29 @@ TURBOPACK=1 pnpm test-dev test/e2e/app-dir/app/
Every branch build will create a tarball for each package in this repository<sup>1</sup> that can be used in external repositories.
You can use this preview build in other packages by using a https://vercel-packages.vercel.app URL instead of a version in the `package.json` e.g.
You can use this preview build in other packages by using a https://vercel-packages.vercel.app URL instead of a version in the `package.json`.
Dependencies are automatically rewritten to use the same commit SHA as the package you are using.
For example, if you install `next` from commit `abc`, `next` will have a dependency on `@next/env` at commit `abc` **and** use `next-swc` from commit `abc` as well.
To use `next` from a specific commit (full SHA required):
```json
{
"dependencies": {
"next": "https://vercel-packages.vercel.app/next/commits/abcd/next"
"next": "https://vercel-packages.vercel.app/next/commits/188f76947389a27e9bcff8ebf9079433679256a7/next"
}
}
```
You can refer to builds only by commit SHAs at the moment.
or, to use `next` from a specific Pull Request (PR number required):
```json
{
"dependencies": {
"next": "https://vercel-packages.vercel.app/next/prs/66445/next"
}
}
```
<sup>1</sup> Not all native packages are built automatically.
`build-and-deploy` excludes slow, rarely used native variants of `next-swc`.