Skip to content

docs: add CI/CD Vercel secret requirements#99

Open
vjalumuru wants to merge 1 commit into
mlc-ai:mainfrom
vjalumuru:fix/issue-92-cicd-secrets-docs
Open

docs: add CI/CD Vercel secret requirements#99
vjalumuru wants to merge 1 commit into
mlc-ai:mainfrom
vjalumuru:fix/issue-92-cicd-secrets-docs

Conversation

@vjalumuru
Copy link
Copy Markdown

Summary

  • add CI/CD Prerequisites section to README
  • document required GitHub Actions secrets for Vercel workflows
  • add docs/ci-cd-secrets.md with setup, workflow mapping, failure modes, and verification steps

Why

Deployment workflows require Vercel secrets but setup requirements were not clearly documented, making CI/CD setup error-prone for maintainers and forks.

Validation

  • verified README now includes secret list, setup steps, failure symptoms, and quick verification
  • verified docs page includes workflow dependency matrix and maintenance note

Fixes #92

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @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

  • README Update: A new "CI/CD Prerequisites" section was added to the README.md to document essential GitHub Actions secrets for Vercel deployment workflows.
  • Vercel Secret Documentation: Required GitHub Actions secrets (VERCEL_TOKEN, VERCEL_ORG_ID, VERCEL_PROJECT_ID) for Vercel workflows are now clearly outlined, including their purpose, setup instructions, failure symptoms, and quick verification steps.
  • Detailed CI/CD Secrets Guide: A new document, docs/ci-cd-secrets.md, was created to provide comprehensive guidance on Vercel CI/CD secrets, featuring a workflow dependency matrix, detailed configuration, value acquisition, failure modes, and a verification checklist.

🧠 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
  • README.md
    • Added a new "CI/CD Prerequisites" section.
    • Included a table listing required Vercel-related GitHub Actions secrets (VERCEL_TOKEN, VERCEL_ORG_ID, VERCEL_PROJECT_ID).
    • Provided step-by-step setup instructions for configuring these secrets.
    • Detailed common failure symptoms if secrets are missing.
    • Outlined quick verification steps to confirm correct setup.
    • Added a link to the new docs/ci-cd-secrets.md for more detailed guidance.
  • docs/ci-cd-secrets.md
    • Created a new document dedicated to Vercel CI/CD secrets.
    • Listed required secrets with their purpose.
    • Included a workflow dependency matrix showing which secrets are used by each Vercel workflow.
    • Provided detailed instructions on how to configure secrets in GitHub.
    • Explained how to obtain the values for VERCEL_TOKEN, VERCEL_ORG_ID, and VERCEL_PROJECT_ID.
    • Described typical failure modes associated with missing secrets.
    • Presented a comprehensive verification checklist.
    • Added a maintenance note for future updates.
Activity
  • No human activity has been recorded on this pull request yet.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Comment on lines +89 to +95
### 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. |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
### 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add missing CI/CD secret requirements for Vercel workflows

1 participant