You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): drop redundant skip-build methods and renumber (#366)
* docs(readme): drop redundant skip-build methods and renumber
- Remove 'Method 1 - via vercel interface' (UI-based toggle)
- Remove 'Method 2 - via project configuration' (buildCommand override in vercel.ts/vercel.json)
- Rename former 'Method 3 - Prebuilt deployments (recommended)' to Method 1
- Rename former 'Method 4 - Build inside the action (vercel-build)' to Method 2
- Update two in-section cross-references from 'Method 3' to 'Method 1'
The removed methods were redundant noise alongside the prebuilt-deployment
approach; keeping only the two actionable methods reduces doc surface area.
* docs(readme): fix vercel-build anchor link after method renumbering
The vercel-build input description in the Experimental API Deployment Inputs table still pointed to the old #method-4-... anchor. Update to #method-2-... to match the renumbered heading.
| target | No |`preview`| Deployment target: `production` or `preview`|
70
70
| prebuilt | No |`false`| Deploy prebuilt output (requires a prior `vercel build` step). Mutually exclusive with `vercel-build`. |
71
-
| vercel-build | No |`false`| Run `vercel pull` + `vercel build` inside the action before deploying, then upload `.vercel/output` via the prebuilt path. Mutually exclusive with `prebuilt`. See ["Build inside the action"](#method-4---build-inside-the-action-vercel-build) below. |
71
+
| vercel-build | No |`false`| Run `vercel pull` + `vercel build` inside the action before deploying, then upload `.vercel/output` via the prebuilt path. Mutually exclusive with `prebuilt`. See ["Build inside the action"](#method-2---build-inside-the-action-vercel-build) below. |
72
72
| vercel-output-dir | No || Custom path to prebuilt output. Defaults to `{working-directory}/.vercel/output`|
73
73
| force | No |`false`| Force new deployment, bypassing dedupe and build cache |
74
74
| env | No || Environment variables (`KEY=VALUE` per line) |
See [Build Command docs](https://vercel.com/docs/deployments/configure-a-build#build-command) and [Programmatic Configuration](https://vercel.com/docs/project-configuration/vercel-ts) for more details.
You can build your project locally (or in GitHub Actions) using `vercel build` and upload only the build artifacts to Vercel — without giving Vercel access to the source code. This uses the [Build Output API](https://vercel.com/docs/build-output-api/v3) specification.
178
145
@@ -207,9 +174,9 @@ jobs:
207
174
208
175
See [Vercel's official GitHub Actions example](https://github.com/vercel/examples/tree/main/ci-cd/github-actions) for more details.
209
176
210
-
#### Method 4 - Build inside the action (`vercel-build`)
177
+
#### Method 2 - Build inside the action (`vercel-build`)
211
178
212
-
If you want the same prebuilt-deploy benefits as Method 3 but prefer not to manage `vercel pull` / `vercel build` steps yourself, set `vercel-build: true`. The action will run `vercel pull` followed by `vercel build` inside the runner and then upload the resulting `.vercel/output` via the prebuilt path.
179
+
If you want the same prebuilt-deploy benefits as Method 1 but prefer not to manage `vercel pull` / `vercel build` steps yourself, set `vercel-build: true`. The action will run `vercel pull` followed by `vercel build` inside the runner and then upload the resulting `.vercel/output` via the prebuilt path.
213
180
214
181
This mirrors the [Vercel KB recommended GitHub Actions workflow](https://vercel.com/kb/guide/how-can-i-use-github-actions-with-vercel#configuring-github-actions-for-vercel) but consolidates pull + build + deploy into a single step.
215
182
@@ -232,7 +199,7 @@ jobs:
232
199
233
200
Notes:
234
201
235
-
- `vercel-build` and `prebuilt` are mutually exclusive. Use `prebuilt: true` if you've already produced `.vercel/output` in an earlier step (Method 3); use `vercel-build: true` to let the action run the build for you.
202
+
- `vercel-build` and `prebuilt` are mutually exclusive. Use `prebuilt: true` if you've already produced `.vercel/output` in an earlier step (Method 1); use `vercel-build: true` to let the action run the build for you.
236
203
- Build-time secrets (`build-env`) are forwarded to `vercel build`.
237
204
- The Vercel token is supplied to the CLI via the `VERCEL_TOKEN` environment variable (the documented non-interactive auth path), never as a `--token` argument.
238
205
- When `target: production` is set, the action passes `--environment=production` to `vercel pull` and `--prod` to `vercel build`.
0 commit comments