Skip to content

Conversation

piyush-jaiswal
Copy link
Owner

@piyush-jaiswal piyush-jaiswal commented Aug 2, 2025

Summary by CodeRabbit

  • Chores
    • Introduced automated preview and production deployment workflows for Vercel, triggered by pull requests and pushes to the master branch.
    • Deployment workflows now include automated testing before deploying to Vercel environments.
    • Updated test workflow to be triggered manually or by other workflows, rather than automatically on pushes or pull requests.
    • Disabled Git-based deployments in the Vercel project configuration.

Copy link

vercel bot commented Aug 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ecommerce-rest-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2025 8:22am

Copy link
Contributor

coderabbitai bot commented Aug 2, 2025

Walkthrough

Two new GitHub Actions workflows were added for deploying preview and production builds to Vercel, each with jobs for testing and deployment. The existing test workflow's triggers were modified to remove automatic runs on pushes and pull requests, enabling invocation only via workflow calls or manual dispatch. Additionally, the Vercel configuration was updated to disable Git-based deployments explicitly.

Changes

Cohort / File(s) Change Summary
Preview Deployment Workflow
.github/workflows/deploy_preview.yml
Introduced a workflow for deploying preview builds to Vercel on PRs to master, with jobs for testing and deployment, concurrency control, and conditional execution.
Production Deployment Workflow
.github/workflows/deploy_production.yml
Added a workflow for deploying production builds to Vercel on pushes to master, with jobs for testing and deployment, concurrency control, and sequential steps for build and deploy.
Test Workflow Trigger Update
.github/workflows/tests.yml
Modified triggers to remove push and PR events; now triggered only by workflow calls or manual dispatch.
Vercel Configuration Update
vercel.json
Added "git": { "deploymentEnabled": false } to disable Git-based deployments in Vercel configuration.

Sequence Diagram(s)

Vercel Deployment Workflow (Preview or Production)

sequenceDiagram
    participant GitHub Actions
    participant Test Job
    participant Deploy Job
    participant Vercel

    GitHub Actions->>Test Job: Start test job (uses tests.yml)
    Test Job-->>GitHub Actions: Report test result
    GitHub Actions->>Deploy Job: Start deploy job (if tests pass)
    Deploy Job->>Vercel: Pull environment config (using token)
    Deploy Job->>Vercel: Build project artifacts
    Deploy Job->>Vercel: Deploy artifacts (preview or production)
    Vercel-->>Deploy Job: Deployment result
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A bunny hops through workflows new,
With Vercel clouds and secrets true.
Preview and prod, both set to deploy,
Tests run first—oh what joy!
GitHub Actions, swift and neat,
Make shipping code a bunny treat.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2ccc661 and 3ba7cdc.

📒 Files selected for processing (3)
  • .github/workflows/deploy_preview.yml (1 hunks)
  • .github/workflows/deploy_production.yml (1 hunks)
  • vercel.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • vercel.json
🚧 Files skipped from review as they are similar to previous changes (2)
  • .github/workflows/deploy_preview.yml
  • .github/workflows/deploy_production.yml
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ci/block-deployment-on-tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (4)
.github/workflows/tests.yml (1)

24-26: Drop debug-only “Check cache hit” step

The step merely echoes an internal output and adds noise / time to every run.

-            # for testing
-            - name: Check cache hit
-              run: echo "${{ steps.cp312.outputs.cache-hit }}"
.github/workflows/deploy_preview.yml (1)

20-35: Add a concurrency group to cancel stale preview builds

Force-pushing to a PR currently spawns parallel builds. Save CI minutes and Vercel slots:

concurrency:
  group: preview-${{ github.event.pull_request.number }}
  cancel-in-progress: true
.github/workflows/deploy_production.yml (2)

24-26: Same version-pinning concern for Vercel CLI

Switch from vercel@canary to a stable tag unless canary features are required.


16-34: Concurrency control prevents overlapping production deployments

Two commits pushed in quick succession trigger two builds; the slower one might overwrite the newer release. Add:

concurrency:
  group: prod-${{ github.ref }}
  cancel-in-progress: false   # or true if you prefer the latest build only
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b08461 and 2ccc661.

📒 Files selected for processing (3)
  • .github/workflows/deploy_preview.yml (1 hunks)
  • .github/workflows/deploy_production.yml (1 hunks)
  • .github/workflows/tests.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: deploy-preview
🔇 Additional comments (2)
.github/workflows/tests.yml (1)

3-5: Reduced CI coverage – deliberate or oversight?

With only workflow_call / workflow_dispatch triggers, the tests workflow no longer runs for feature-branch pushes or PRs that don’t target master. Regressions could slip in unnoticed until a deployment workflow fires. Please confirm that this reduction in test coverage is intentional.

.github/workflows/deploy_production.yml (1)

8-10: Automatic prod deploy on every push to master – add a safety net

A direct push to master deploys to production immediately. Consider requiring an environment-level approval or a workflow_run manual gate to avoid accidental releases.

@piyush-jaiswal piyush-jaiswal merged commit ca2b620 into master Aug 2, 2025
3 checks passed
@piyush-jaiswal piyush-jaiswal deleted the ci/block-deployment-on-tests branch August 2, 2025 09:25
This was referenced Aug 22, 2025
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.

1 participant