Skip to content

Commit 2c6dad5

Browse files
authored
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.
1 parent de09aea commit 2c6dad5

1 file changed

Lines changed: 5 additions & 38 deletions

File tree

README.md

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ These typed inputs map onto `@vercel/client`'s `DeploymentOptions` and `VercelCl
6868
|----------------------------|:--------:|-----------|--------------------------------------------------------------------|
6969
| target | No | `preview` | Deployment target: `production` or `preview` |
7070
| 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. |
7272
| vercel-output-dir | No | | Custom path to prebuilt output. Defaults to `{working-directory}/.vercel/output` |
7373
| force | No | `false` | Force new deployment, bypassing dedupe and build cache |
7474
| env | No | | Environment variables (`KEY=VALUE` per line) |
@@ -139,40 +139,7 @@ export const config: VercelConfig = {
139139

140140
Since we do the `build` in `github actions`, we don't need to build in `vercel`.
141141

142-
#### Method 1 - via vercel interface
143-
144-
- Specify "Other" as the framework preset, and
145-
- Enable the Override option for the Build Command, and
146-
- Leave the Build Command **empty**.
147-
- This will prevent the build from being attempted and serve your content as-is.
148-
149-
See [docs](https://vercel.com/docs/concepts/deployments/build-step#build-command) for more details
150-
151-
#### Method 2 - via project configuration
152-
153-
You can override the build command in your project configuration to skip Vercel's build step.
154-
155-
**`vercel.ts`** (recommended):
156-
157-
```typescript
158-
import type { VercelConfig } from '@vercel/config/v1';
159-
160-
export const config: VercelConfig = {
161-
buildCommand: '',
162-
};
163-
```
164-
165-
**`vercel.json`**:
166-
167-
```json
168-
{
169-
"buildCommand": ""
170-
}
171-
```
172-
173-
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.
174-
175-
#### Method 3 - Prebuilt deployments (recommended)
142+
#### Method 1 - Prebuilt deployments (recommended)
176143

177144
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.
178145

@@ -207,9 +174,9 @@ jobs:
207174
208175
See [Vercel's official GitHub Actions example](https://github.com/vercel/examples/tree/main/ci-cd/github-actions) for more details.
209176
210-
#### Method 4 - Build inside the action (`vercel-build`)
177+
#### Method 2 - Build inside the action (`vercel-build`)
211178

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.
213180

214181
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.
215182

@@ -232,7 +199,7 @@ jobs:
232199

233200
Notes:
234201

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.
236203
- Build-time secrets (`build-env`) are forwarded to `vercel build`.
237204
- 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.
238205
- When `target: production` is set, the action passes `--environment=production` to `vercel pull` and `--prod` to `vercel build`.

0 commit comments

Comments
 (0)