docs(readme): drop redundant skip-build methods and renumber - #366
Conversation
- 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.
|
Deploy preview for team-scope-test ready!
Deployed with vercel-action |
|
Deploy preview for express-basic-auth ready!
Deployed with vercel-action |
|
Deploy preview for zeit-now-deployment-action-example-angular ready!
Deployed with vercel-action |
There was a problem hiding this comment.
Pull request overview
This PR streamlines the README guidance for skipping Vercel’s build step by removing redundant approaches and renumbering the remaining recommended methods to reduce user confusion.
Changes:
- Removed two “skip build” methods that relied on Vercel UI settings or
buildCommandoverrides. - Renumbered the remaining approaches so “Prebuilt deployments” is now Method 1 and
vercel-buildis now Method 2. - Updated in-section references from the old method numbers to the new ones.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 1 file
Auto-approved: Documentation-only change: simplifies and renumbers instructions in README.md without affecting any source code or logic.
Architecture diagram
sequenceDiagram
participant Runner as GitHub Actions Runner
participant Action as Vercel Action
participant CLI as Vercel CLI (Internal)
participant Vercel as Vercel API / Platform
Note over Runner, Vercel: Simplified Build-Skip Flow (Prebuilt Path)
alt Method 1: Prebuilt (Manual Build)
Runner->>CLI: vercel build
CLI-->>Runner: Generate .vercel/output
Runner->>Action: CHANGED: Invoke with prebuilt: true
Action->>Action: Verify .vercel/output exists
else Method 2: vercel-build (Managed Build)
Runner->>Action: CHANGED: Invoke with vercel-build: true
Action->>CLI: vercel pull (env setup)
Action->>CLI: vercel build
CLI-->>Action: Generate .vercel/output
end
Action->>Vercel: Upload .vercel/output (Build Output API)
Note right of Vercel: Vercel skips standard build step
Vercel-->>Action: Deployment Created
Action-->>Runner: Output Deployment URL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the documentation by removing outdated deployment methods and renumbering the remaining sections. A review comment correctly identifies that renumbering 'Method 4' to 'Method 2' results in broken cross-references in other parts of the README and the action.yml file, which need to be updated to maintain documentation integrity.
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.
|
Summary
Cleaned up the "Skip vercel's build step" section by removing two methods that were redundant alongside the prebuilt-deployment approach.
Changes
Removed:
Kept and renumbered:
vercel-build) → now Method 2Updated two in-section cross-references that referred to "Method 3" → "Method 1".
Unchanged: The "Disable Vercel for GitHub" section was intentionally left as-is.
Rationale
The removed methods required users to configure things in the Vercel UI or override
buildCommandin project config, but those approaches are superseded by the prebuilt-deployment pattern (now Method 1) which is already documented as the recommended path. Keeping them added noise and created confusion about which method to follow.Summary by cubic
Simplified the README’s “Skip Vercel build step” by removing the UI toggle and project
buildCommandoverride, consolidating around prebuilt deployments. Prebuilt deployments are now Method 1, building inside the action withvercel-buildis Method 2; cross-references were updated and thevercel-buildinput now links to the correct Method 2 anchor.Written for commit 75bb811. Summary will update on new commits. Review in cubic