sim icon indicating copy to clipboard operation
sim copied to clipboard

docs: clarify working directory for drizzle migration

Open Shivam-002 opened this issue 1 week ago • 2 comments

Added a note to Self-hosted: Manual Setup that you should cd apps/sim before running bunx drizzle-kit migrate so that drizzle picks up the correct .env file.

Summary

Clarifies that the user must change into apps/sim before running the database migration to ensure the correct .env file is used.

Fixes #N/A

Type of Change

  • [ ] Bug fix
  • [ ] New feature
  • [ ] Breaking change
  • [x] Documentation
  • [ ] Other: ___________

Testing

Reviewed locally by following the setup steps in the documentation to ensure the added note makes the migration command clear.

Checklist

  • [ ] Code follows project style guidelines
  • [ ] Self-reviewed my changes
  • [ ] Tests added/updated and passing
  • [ ] No new warnings introduced
  • [ ] I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

Shivam-002 avatar Dec 15 '25 08:12 Shivam-002

@Shivam-002 is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Dec 15 '25 08:12 vercel[bot]

Greptile Overview

Greptile Summary

Adds a clarifying note to the manual setup instructions that users should cd apps/sim before running the drizzle migration command. This ensures the correct .env file is picked up from apps/sim rather than packages/db, which is critical since the apps/sim/drizzle.config.ts loads environment variables from the app's env configuration.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change that adds a helpful clarification to prevent user confusion during setup. The added note accurately reflects the requirement to be in apps/sim directory for the drizzle migration to pick up the correct environment file.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
README.md 5/5 Added helpful clarification about working directory for drizzle migration command

Sequence Diagram

sequenceDiagram
    participant User
    participant Terminal
    participant DrizzleKit
    participant EnvConfig as apps/sim/.env
    participant DrizzleConfig as apps/sim/drizzle.config.ts
    
    User->>Terminal: cd apps/sim
    Note over Terminal: Set working directory to apps/sim
    User->>Terminal: bunx drizzle-kit migrate --config=./drizzle.config.ts
    Terminal->>DrizzleKit: Execute migration
    DrizzleKit->>DrizzleConfig: Load config from ./drizzle.config.ts
    DrizzleConfig->>EnvConfig: Import env from lib/core/config/env.ts
    EnvConfig-->>DrizzleConfig: Return DATABASE_URL
    DrizzleConfig-->>DrizzleKit: Return database credentials
    DrizzleKit->>DrizzleKit: Run migrations
    DrizzleKit-->>User: Migration complete

greptile-apps[bot] avatar Dec 15 '25 08:12 greptile-apps[bot]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Dec 15, 2025 6:53pm

vercel[bot] avatar Dec 15 '25 18:12 vercel[bot]