-
Notifications
You must be signed in to change notification settings - Fork 219
docs: add CI/CD Vercel secret requirements #99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vjalumuru
wants to merge
1
commit into
mlc-ai:main
Choose a base branch
from
vjalumuru:fix/issue-92-cicd-secrets-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # CI/CD Secrets for Vercel Workflows | ||
|
|
||
| This document explains the GitHub Actions secrets required by Vercel-related workflows in this repository. | ||
|
|
||
| ## Required Secrets | ||
|
|
||
| | Secret | Required | Purpose | | ||
| | --- | --- | --- | | ||
| | `VERCEL_TOKEN` | Yes | Authenticates Vercel CLI commands and Vercel API calls used in deployment and preview cleanup. | | ||
| | `VERCEL_ORG_ID` | Yes | Identifies the Vercel team/org context used by workflows. | | ||
| | `VERCEL_PROJECT_ID` | Yes | Identifies the Vercel project to deploy and manage. | | ||
|
|
||
| ## Workflow Dependency Matrix | ||
|
|
||
| | Workflow | Trigger | Secrets Used | | ||
| | --- | --- | --- | | ||
| | [.github/workflows/vercel_deploy.yaml](../.github/workflows/vercel_deploy.yaml) | Push to `main` | `VERCEL_TOKEN`, `VERCEL_ORG_ID`, `VERCEL_PROJECT_ID` | | ||
| | [.github/workflows/deploy_preview.yml](../.github/workflows/deploy_preview.yml) | Push to non-`main` branches | `VERCEL_TOKEN`, `VERCEL_ORG_ID`, `VERCEL_PROJECT_ID` | | ||
| | [.github/workflows/remove_deploy_preview.yml](../.github/workflows/remove_deploy_preview.yml) | `pull_request_target` on close | `VERCEL_TOKEN`, `VERCEL_ORG_ID`, `VERCEL_PROJECT_ID` | | ||
|
|
||
| ## How to Configure Secrets in GitHub | ||
|
|
||
| 1. Open the repository on GitHub. | ||
| 2. Navigate to **Settings > Secrets and variables > Actions**. | ||
| 3. Select **New repository secret**. | ||
| 4. Add each required secret: | ||
| - `VERCEL_TOKEN` | ||
| - `VERCEL_ORG_ID` | ||
| - `VERCEL_PROJECT_ID` | ||
| 5. Re-run failed workflows or push a new commit to validate setup. | ||
|
|
||
| ## How to Obtain Values | ||
|
|
||
| - `VERCEL_TOKEN`: Create a personal/team token in Vercel account settings. | ||
| - `VERCEL_ORG_ID` and `VERCEL_PROJECT_ID`: Available from Vercel project settings or via Vercel CLI project linking metadata. | ||
|
|
||
| ## Typical Failure Modes | ||
|
|
||
| ### Missing `VERCEL_TOKEN` | ||
|
|
||
| - `vercel pull` fails during environment fetch. | ||
| - `vercel build` / `vercel deploy` fails with authentication errors. | ||
| - Preview cleanup script cannot call Vercel API delete endpoints. | ||
|
|
||
| ### Missing `VERCEL_ORG_ID` or `VERCEL_PROJECT_ID` | ||
|
|
||
| - Vercel CLI cannot resolve project context for pull/build/deploy. | ||
| - Cleanup script cannot query correct deployment list for deletion. | ||
|
|
||
| ## Verification Checklist | ||
|
|
||
| - Non-main branch push completes preview deployment workflow. | ||
| - Main branch push/merge completes production deployment workflow. | ||
| - Closing a PR from a preview branch triggers deployment cleanup workflow. | ||
|
|
||
| ## Maintenance Note | ||
|
|
||
| When workflow files change secret usage, update this document and the README CI/CD prerequisites section in the same pull request. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current table format is a bit wide and repetitive due to the 'Used by' column. Since all secrets are used by the same set of workflows, this section could be simplified by using a list. This would make it more concise and improve readability, especially on smaller screens. The detailed workflow-to-secret mapping is already well-documented in
docs/ci-cd-secrets.md.