docs: add CI/CD Vercel secret requirements#99
Conversation
Summary of ChangesHello @vjalumuru, 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 significantly improves the clarity and reliability of CI/CD setup for Vercel deployments by thoroughly documenting the necessary GitHub Actions secrets. It addresses previous difficulties maintainers and forks faced due to undocumented secret requirements, providing clear instructions and troubleshooting guidance to ensure smooth and error-free continuous integration and deployment processes. 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. Changelog
Activity
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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation by adding clear instructions for setting up CI/CD secrets for Vercel. The new section in README.md and the detailed guide in docs/ci-cd-secrets.md are well-structured and will be very helpful for maintainers and contributors. I have one suggestion to improve the readability of the README.md by using a list instead of a table for the secrets, which makes the information more concise. Overall, this is an excellent and much-needed documentation update.
| ### Required GitHub Actions Secrets | ||
|
|
||
| | Secret | Used by | Purpose | | ||
| | --- | --- | --- | | ||
| | `VERCEL_TOKEN` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Authenticates Vercel CLI and cleanup API calls. | | ||
| | `VERCEL_ORG_ID` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Selects Vercel organization/team context. | | ||
| | `VERCEL_PROJECT_ID` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Selects target Vercel project. | |
There was a problem hiding this comment.
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.
| ### Required GitHub Actions Secrets | |
| | Secret | Used by | Purpose | | |
| | --- | --- | --- | | |
| | `VERCEL_TOKEN` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Authenticates Vercel CLI and cleanup API calls. | | |
| | `VERCEL_ORG_ID` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Selects Vercel organization/team context. | | |
| | `VERCEL_PROJECT_ID` | `.github/workflows/vercel_deploy.yaml`, `.github/workflows/deploy_preview.yml`, `.github/workflows/remove_deploy_preview.yml` | Selects target Vercel project. | | |
| ### Required GitHub Actions Secrets | |
| The following secrets are used by all Vercel deployment workflows: | |
| * `VERCEL_TOKEN`: Authenticates Vercel CLI and cleanup API calls. | |
| * `VERCEL_ORG_ID`: Selects Vercel organization/team context. | |
| * `VERCEL_PROJECT_ID`: Selects target Vercel project. |
Summary
CI/CD Prerequisitessection to READMEdocs/ci-cd-secrets.mdwith setup, workflow mapping, failure modes, and verification stepsWhy
Deployment workflows require Vercel secrets but setup requirements were not clearly documented, making CI/CD setup error-prone for maintainers and forks.
Validation
Fixes #92