docs(skill): add use-vercel-action agent skill and README install steps#367
Merged
Conversation
Adds a Claude Code agent skill that documents how to wire amondnet/vercel-action into a GitHub Actions workflow. Consumers install it with: npx skills add amondnet/vercel-action The skill (skills/use-vercel-action/SKILL.md) covers: - Prerequisites checklist (tokens, org/project IDs, vercel.json flag) - Quick-start YAML and five common patterns (production deploy, two prebuilt flows, alias domains, GitHub Deployments) - Essentials input table with every name cross-checked against action.yml - Outputs, mutual-exclusion gotchas, and references README.md gains a new ## Claude Code Skill section between ## Outputs and ## How To Use, advertising the install command and linking to the skill source.
Contributor
|
Deploy preview for express-basic-auth ready!
Deployed with vercel-action |
Contributor
|
Deploy preview for zeit-now-deployment-action-example-angular ready!
Deployed with vercel-action |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a Claude Code skill for the amondnet/vercel-action, adding a new SKILL.md file and updating the README.md to facilitate AI-driven workflow configuration. The new documentation covers prerequisites, deployment patterns, and input/output specifications. Review feedback recommends updating the documentation to explicitly mark vercel-org-id and vercel-project-id as required inputs, ensuring consistency with the main README and modern Vercel CLI requirements.
Contributor
|
Deploy preview for team-scope-test ready!
Deployed with vercel-action |
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation to help AI assistants and humans correctly configure amondnet/vercel-action in GitHub Actions, with a new Claude Code “agent skill” doc and a README entry pointing to it.
Changes:
- Added
skills/use-vercel-action/SKILL.mddocumenting prerequisites, common workflow patterns, essential inputs/outputs, and gotchas. - Updated
README.mdwith a new “Claude Code Skill” section including install instructions and a link to the skill source.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| skills/use-vercel-action/SKILL.md | New skill documentation for wiring the action into workflows, including patterns, inputs/outputs, and exclusions. |
| README.md | Adds a section advertising the Claude Code skill and how to install it. |
💡 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.
2 issues found across 2 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="skills/use-vercel-action/SKILL.md">
<violation number="1" location="skills/use-vercel-action/SKILL.md:19">
P2: This references a `vercel:vercel-cli` skill that does not exist in this repository (only `use-vercel-action` is shipped under `skills/`). Link to the official Vercel CLI docs instead to avoid sending users to a non-existent resource.</violation>
<violation number="2" location="skills/use-vercel-action/SKILL.md:199">
P2: Clarify that GitHub Deployment environment auto-detection depends on deployment mode: CLI mode uses `vercel-args`, but experimental API mode follows `target`.
(Based on your team's feedback about using the typed deployment target in experimental API mode.) [FEEDBACK_USED]</violation>
</file>
Architecture diagram
sequenceDiagram
participant Dev as Developer
participant AI as Claude Code (AI Agent)
participant Repo as GitHub Repository
participant GHA as GitHub Actions Runner
participant Vercel as Vercel API / CLI
participant GH_API as GitHub API
Note over Dev,Repo: Setup & Knowledge Injection
Dev->>Repo: NEW: Install Skill via npx skills add
Repo-->>AI: Load SKILL.md (Inputs, Outputs, Logic)
Note over Dev,GHA: Development & Configuration Flow
Dev->>AI: "Configure Vercel preview deploys"
AI->>AI: Process SKILL.md patterns
Note right of AI: Checks for mutual exclusions<br/>(e.g., prebuilt vs vercel-build)
AI->>Dev: Suggests vercel.json (disable native git)
AI->>Dev: Generates YAML workflow with secrets
Dev->>Repo: Push .github/workflows/deploy.yml
Note over GHA,GH_API: Runtime Execution (The Action)
Repo->>GHA: Trigger Workflow (Push/PR)
GHA->>GHA: Load amondnet/vercel-action
alt Mode: CLI (Default)
GHA->>Vercel: Execute 'vercel deploy' with vercel-args
else Mode: NEW/CHANGED: Experimental API
GHA->>Vercel: Call @vercel/client directly
end
opt Mode: Prebuilt Flow (documented in skill)
GHA->>GHA: NEW: vercel pull && vercel build
GHA->>Vercel: Deploy .vercel/output
end
GHA-->>Vercel: Perform Deployment
Vercel-->>GHA: Return preview-url & name
opt CHANGED: GitHub Integrations (via SKILL.md config)
alt Create Deployment
GHA->>GH_API: NEW: Update Deployment Status (success/failure)
Note right of GH_API: Requires 'permissions: deployments: write'
else PR Comment
GHA->>GH_API: Post preview-url to Pull Request
end
end
GHA-->>Dev: Final deployment state
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
- Mark vercel-org-id and vercel-project-id as required to align with README - Add npm install --global vercel@latest step to Prebuilt Method 1 example - Replace vercel:vercel-cli skill reference with vercel.com/docs/cli - Document vercel-build/vercel-args mutual exclusion (enforced at src/config.ts:120) - Clarify GitHub Deployment env auto-detection is mode-dependent (CLI reads vercel-args, API reads target — src/config.ts:74-86) Addresses gemini-code-assist, copilot-pull-request-reviewer, and cubic-dev-ai review threads on PR #367.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR ships a new Claude Code agent skill that documents how consumers wire
amondnet/vercel-actioninto a GitHub Actions workflow. AI assistants that have the skill installed can correctly set up required tokens and IDs, choose between CLI and experimental API mode, configure prebuilt flows, alias domains, and GitHub Deployments — without guessing at input names or syntax.Changes
skills/use-vercel-action/SKILL.md(207 lines) — agent skill with frontmatter (name: use-vercel-action), prerequisites checklist, quick-start YAML, five common deployment patterns, a full essentials input table, outputs, mutual-exclusion gotchas, and references. Every input name was cross-checked againstaction.yml.README.md— added a new## Claude Code Skillsection between## Outputsand## How To Use, advertising the install command, sample trigger prompts, and a link to the skill source.How to use
Once installed, prompts like "deploy to Vercel from GitHub Actions", "post a Vercel preview URL on a PR", or "set up prebuilt Vercel deployments" will surface the skill automatically in Claude Code.
Verification
SKILL.mdis 207 lines — well under the 300 LOC file budget.action.ymlto ensure accuracy.${{ secrets.* }}references for tokens and IDs.permissions: deployments: writeas required by the GitHub API.Summary by cubic
Adds a Claude Code skill that shows how to wire
amondnet/vercel-actioninto GitHub Actions and updates the README with install steps. Also applies review feedback to tighten prerequisites, prebuilt flow steps, and deployment environment behavior.New Features
skills/use-vercel-action/SKILL.mdwith prerequisites, quick-start YAML, common patterns (prod, prebuilt flows, alias domains, GitHub Deployments), essentials inputs/outputs, and mutual-exclusion notes; inputs verified againstaction.yml.README.mdwith a "Claude Code Skill" section, install command (npx skills add amondnet/vercel-action), and a link to the skill.Bug Fixes
vercel-org-idandvercel-project-idas required in the skill to align with the README.npm install --global vercel@latestand links to the official Vercel CLI docs.vercel-buildcannot be combined withvercel-args; GitHub Deployment environment auto-detection is mode-dependent (CLI readsvercel-args, API readstarget).Written for commit 28ca884. Summary will update on new commits. Review in cubic