fix: auto-retry deployment when personal account org ID causes scope error#298
fix: auto-retry deployment when personal account org ID causes scope error#298
Conversation
…error Vercel CLI v41+ rejects VERCEL_ORG_ID for personal accounts with "You cannot set your Personal Account as the scope" error. - Catch the scope error and retry without VERCEL_ORG_ID using --project flag - Remove vercel-org-id from personal account CI workflows - Rebuild dist/
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a breaking change introduced in Vercel CLI v41 that prevented deployments from personal accounts when Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
Deploy preview for express-basic-auth ready! ✅ Preview Built with commit 8773840. |
![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 refactors the Vercel deployment logic by extracting argument building into dedicated functions and introduces a retry mechanism. Specifically, if a Vercel deployment fails because a personal account is used as a scope, the action will now retry the deployment by clearing the VERCEL_ORG_ID and explicitly using the --project flag. Feedback indicates a potential issue where the scope argument might be incorrectly re-added during the retry, which could lead to repeated failures. It is also suggested to refactor the argument building logic for the retry into a helper function to avoid duplication and improve maintainability.
There was a problem hiding this comment.
Pull request overview
This PR updates the Vercel GitHub Action to handle a Vercel CLI v41+ failure mode where personal accounts reject VERCEL_ORG_ID/scope, by retrying the deploy without the org scope and using --project instead. It also removes vercel-org-id usage from the repository’s personal-account example workflows.
Changes:
- Detects the “You cannot set your Personal Account as the scope” deploy failure and retries without
VERCEL_ORG_ID, adding--projectas a fallback. - Refactors deploy argument construction into
buildDeployArgs()andappendProjectArgs()helpers. - Removes
vercel-org-idfrom personal-account example workflows and rebuildsdist/index.js.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| index.js | Adds scope-error detection and retry logic; refactors deploy arg building. |
| dist/index.js | Compiled output updated to include the new retry behavior. |
| .github/workflows/deploy.yml | Removes vercel-org-id from the deploy workflow configuration. |
| .github/workflows/example-angular.yml | Removes vercel-org-id from the Angular example workflow. |
| .github/workflows/example-nextjs.yml | Removes vercel-org-id from the Next.js example workflow. |
| .github/workflows/example-static.yml | Removes vercel-org-id from the static example workflow. |
💡 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 6 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="index.js">
<violation number="1" location="index.js:225">
P2: Setting `VERCEL_ORG_ID` to empty string does not remove it from the process environment. The spawned child process will still see `VERCEL_ORG_ID=''`. Add `delete process.env.VERCEL_ORG_ID` to fully remove it so the retry's `npx vercel` invocation cannot detect the variable at all.</violation>
<violation number="2" location="index.js:231">
P1: The retry path still appends `--scope` when `vercelScope` is set. If the scope input itself triggered the personal-account error (rather than `VERCEL_ORG_ID`), the retry will fail with the same error. Skip `--scope` on the retry attempt to ensure the fallback actually works.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
- Restore independent VERCEL_PROJECT_ID export (was incorrectly nested) - Clear process.env.VERCEL_ORG_ID for in-process retry subprocess - Guard retry with vercelProjectId check for actionable error message
There was a problem hiding this comment.
1 issue found across 2 files (changes from recent commits).
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="index.js">
<violation number="1" location="index.js:232">
P2: The `delete` is immediately undone by `core.exportVariable` on the next line, leaving `VERCEL_ORG_ID=''` in the environment for the retry subprocess. Swap the order so that `exportVariable` writes to `GITHUB_ENV` for future steps first, then `delete` removes it from `process.env` for the current retry.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
- Remove --scope from retry path to prevent personal-account error from recurring on the fallback attempt - Swap order of exportVariable/delete so process.env.VERCEL_ORG_ID is cleared after GITHUB_ENV is written, not before
|
There was a problem hiding this comment.
0 issues found across 2 files (changes from recent commits).
Requires human review: This PR refactors core deployment logic, introduces error-based retry handling, and extracts logic into helpers, which requires human validation of the execution flow and fallback behavior.
- Add core.setSecret for vercel token to prevent log exposure - Disable telemetry with VERCEL_TELEMETRY_DISABLED env var - Require both org and project IDs together (v41+ compat) - Auto-retry deployment on personal account scope error - Sanitize commit message newlines and quotes in metadata - Add ignoreReturnCode for proper exit code handling - Update tests for new behavior (105 total)
- Add core.setSecret for vercel token to prevent log exposure - Disable telemetry with VERCEL_TELEMETRY_DISABLED env var - Require both org and project IDs together (v41+ compat) - Auto-retry deployment on personal account scope error - Sanitize commit message newlines and quotes in metadata - Add ignoreReturnCode for proper exit code handling - Update tests for new behavior (105 total)
- Add core.setSecret for vercel token to prevent log exposure - Disable telemetry with VERCEL_TELEMETRY_DISABLED env var - Require both org and project IDs together (v41+ compat) - Auto-retry deployment on personal account scope error - Sanitize commit message newlines and quotes in metadata - Add ignoreReturnCode for proper exit code handling - Update tests for new behavior (105 total)
* refactor: migrate to TypeScript with Vitest and modern tooling BREAKING CHANGE: @actions/github upgraded from v2 to v6 - Convert index.js to src/index.ts with strict TypeScript mode - Extract pure utility functions to src/utils.ts for testability - Add tsconfig.json with strict compiler options - Replace Jest with Vitest for faster, ESM-native testing - Add comprehensive unit tests for utility functions (43 tests) - Add integration tests for GitHub Action structure (12 tests) - Target: 80%+ code coverage - Migrate from deprecated `new github.GitHub(token)` to `github.getOctokit(token)` - Update all API calls from `octokit.repos.*` to `octokit.rest.repos.*` - Update all API calls from `octokit.issues.*` to `octokit.rest.issues.*` - Update all API calls from `octokit.git.*` to `octokit.rest.git.*` - Enable TypeScript support in @antfu/eslint-config - Replace Jest globals with Vitest globals (vi instead of jest) - Add lib/ to ignore patterns - Update ncc build to compile TypeScript directly - Add source maps and licenses to dist output - Add typecheck script for standalone type checking - Update all npm scripts for TypeScript workflow - index.js (migrated to src/index.ts) - index.test.js (migrated to src/__tests__/*.test.ts) - jest.config.js (replaced by vitest.config.ts) - now.js (unused legacy file) Closes #291 * chore: apply AI code review suggestions - Move PullRequestPayload and ReleasePayload interfaces to top of file - Use PullRequestPayload type instead of inline type assertion - Simplify parseArgs regex match logic (remove redundant fallback) * refactor: split index.ts into smaller modules - Extract types to src/types.ts - Extract config and initialization to src/config.ts - Extract Vercel functions to src/vercel.ts - Extract GitHub comment functions to src/github-comments.ts - Refactor run() into smaller focused functions (< 50 LOC each) - Add try-catch around execSync for git log with descriptive error - Add error handling for GitHub API calls - Make alias failures explicit with warning messages - Extract magic numbers to named constants (RETRY_DELAY_MS, ALIAS_RETRY_COUNT) - Use buildCommentPrefix() consistently in both comment functions All files now under 300 LOC limit, all functions under 50 LOC limit. * build: rebuild dist after refactoring * build: update vercel to v50 * fix: improve error handling in vercel deploy and comment functions - Extract and validate deployment URL from vercel CLI stdout - Wrap vercelInspect exec in try-catch to prevent action failure - Expand try-catch scope in comment functions to cover API lookups - Route stderr to core.warning for better error visibility * test: add tests for vercel, config, and github-comments modules - Add vercel.test.ts: URL extraction, inspect regex, alias retry - Add config.test.ts: alias domain substitution, env export - Add github-comments.test.ts: comment create/update, error handling - Total tests: 55 → 100 * fix: port personal account scope error handling from PR #297/#298 - Add core.setSecret for vercel token to prevent log exposure - Disable telemetry with VERCEL_TELEMETRY_DISABLED env var - Require both org and project IDs together (v41+ compat) - Auto-retry deployment on personal account scope error - Sanitize commit message newlines and quotes in metadata - Add ignoreReturnCode for proper exit code handling - Update tests for new behavior (105 total) * refactor: use DeploymentContext object in vercelDeploy signature Reduce parameter count from 6 to 2 by passing DeploymentContext object instead of individual ref, commit, sha, commitOrg, commitRepo arguments. Aligns with AGENTS.md parameter limit of 5. * fix: port alias retry without --scope for personal accounts (#310) Capture stderr in alias exec and retry without --scope when Vercel CLI rejects personal account scope, matching the deploy retry pattern. Add tests for alias scope retry, retry failure, and non-scope failures. * fix: remove declaration maps to fix check-dist CI failure Source map files (.d.ts.map) contain absolute local paths that differ between local builds and CI runners, causing check-dist to fail. Disable declarationMap in tsconfig.json since these files are not needed for GitHub Action runtime execution. * chore: apply AI code review suggestions - Implement exponential backoff in retry function (was constant delay) - Fix debug log for head_commit to use JSON.stringify - Change vercelInspect stderr logging from warning to info level - Fix retry after PERSONAL_ACCOUNT_SCOPE_ERROR to omit --scope - Bump @types/node from ^20.0.0 to ^24.0.0 to match Node 24 runtime - Add setSecret to @actions/core mock in index.test.ts - Fix mock path in config.test.ts from ../package.json to ../../package.json - Update test expectation to match mocked vercel version (30.0.0) - Remove pull_request_target from PullRequestPayload (always undefined) - Add per_page: 100 to comment listing API calls to reduce duplicate risk - Fix Node version in session-summary.md (20 → 24) * fix: make vercelScope optional to clean up retry cast in vercelDeploy Co-authored-by: amondnet <1964421+amondnet@users.noreply.github.com> Agent-Logs-Url: https://github.com/amondnet/vercel-action/sessions/16d171b4-3be8-43f8-a736-b5f3ff13deba --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: amondnet <1964421+amondnet@users.noreply.github.com>
setEnv()exportedVERCEL_PROJECT_IDunconditionally, causing Vercel CLI v41 scope error even withoutVERCEL_ORG_IDsetEnv()to only exportVERCEL_PROJECT_IDwhenvercelOrgIdis setdelete process.env.VERCEL_PROJECT_IDdist/index.js⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.