-
Notifications
You must be signed in to change notification settings - Fork 856
DC-5040 Env Vars via Config #7227
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
Conversation
WalkthroughDocumentation and CI/config updates add dotenv-based environment setup guidance, expand .coderabbit.yaml review settings, and remove Lychee’s --verbose flag while trimming its report output handling. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Pre-merge checks✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🧠 Learnings (3)📚 Learning: 2025-10-08T16:23:00.388ZApplied to files:
📚 Learning: 2025-08-11T09:40:55.237ZApplied to files:
📚 Learning: 2025-10-09T21:32:50.340ZApplied to files:
⏰ 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). (2)
Comment |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| Latest commit: |
70236aa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://326e1676.docs-51g.pages.dev |
| Branch Preview URL: | https://dc-5040-env-vars-via-client.docs-51g.pages.dev |
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.
Actionable comments posted: 1
🧹 Nitpick comments (6)
content/200-orm/200-prisma-client/000-setup-and-configuration/010-generating-prisma-client.mdx (1)
127-154: Clarify that prisma.config.ts must be created prior to these instructions.The section jumps directly to updating
prisma.config.tswithout explaining how users should initialize it if they haven't already. Consider adding a note that this assumes the file exists in the project root, or link to the section on setting up your project in the Prisma Config reference.content/100-getting-started/01-quickstart-sqlite.mdx (3)
96-121: Inconsistent placeholder text across quickstarts.File 3 uses
"your_database_url_here"(line 107), while Files 1 & 2 use"your_database_connection_string_here". Align placeholder text for consistency. For SQLite, a brief note that this typically points to a local file path (e.g.,"file:./dev.db") would help users unfamiliar with SQLite connection strings.
96-121: Ensure prisma.config.ts is properly initialized before configuration step.The section jumps to "Update your
prisma.config.ts" without confirming the file exists or was created byprisma init. For SQLite, clarify whether users should runnpx prisma init --datasource-provider sqlitefirst, or if this step is already covered earlier (line 64 mentions--outputflag). The instructions should be explicit about file generation/initialization.
96-121: Consider relocating section or adding reference to avoid repetition with migration step.Section 3 (lines 96–121) configures the environment, but Section 4 (line 123) immediately runs the migration. Since both involve the database setup, consider adding a brief note explaining that the .env configuration must be in place before migrations run, or merging the conceptual narrative. Also ensure step numbering in the prose matches actual section numbers (the heading says "## 3" and "## 4").
content/100-getting-started/01-quickstart-prismaPostgres.mdx (2)
47-72: Align placeholder text with other quickstarts (Files 1 & 2).Use
"your_database_connection_string_here"consistently across all quickstarts, or explain why Prisma Postgres uses the shorter"your_database_url_here"variant. For consistency, consider standardizing.
47-90: Clarify where prisma.config.ts is initialized and confirm its existence.Lines 61–72 reference updating
prisma.config.ts, but the quickstart doesn't explicitly showprisma initcreating this file. If it's created byprisma init, clarify this. If users must create it manually, provide an initialization step or reference the Prisma Config setup guide.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.coderabbit.yaml(2 hunks).github/workflows/lychee.yml(0 hunks)content/100-getting-started/01-quickstart-prismaPostgres.mdx(1 hunks)content/100-getting-started/01-quickstart-sqlite.mdx(1 hunks)content/200-orm/200-prisma-client/000-setup-and-configuration/010-generating-prisma-client.mdx(1 hunks)content/200-orm/500-reference/325-prisma-config-reference.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- .github/workflows/lychee.yml
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-10-09T21:32:50.340Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7167
File: content/900-ai/prompts/astro.mdx:84-84
Timestamp: 2025-10-09T21:32:50.340Z
Learning: The `npx prisma init` command supports the following flags: `--db` (shorthand for `--datasource-provider prisma+postgres`), `--output` (specifies output location for generated client), `--generator-provider` (defines the generator provider), `--datasource-provider`, `--url`, `--preview-feature`, and `--with-model`. These are documented valid CLI options for Prisma init command.
Applied to files:
content/100-getting-started/01-quickstart-sqlite.mdxcontent/200-orm/200-prisma-client/000-setup-and-configuration/010-generating-prisma-client.mdxcontent/200-orm/500-reference/325-prisma-config-reference.mdxcontent/100-getting-started/01-quickstart-prismaPostgres.mdx
📚 Learning: 2025-10-08T16:23:00.388Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: All headings and titles should use sentence case (e.g., "Getting started with Prisma ORM", "Best practices for authentication"), not title case. Exception: Always preserve exact casing for product names including "Prisma Postgres", "Prisma", "Prisma ORM", and "Prisma Data Platform".
Applied to files:
content/100-getting-started/01-quickstart-prismaPostgres.mdx
⏰ 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). (2)
- GitHub Check: Check links
- GitHub Check: runner / linkspector
🔇 Additional comments (4)
.coderabbit.yaml (2)
4-4: Clever tone directive that aligns with review philosophy.The
tone_instructionsnicely encapsulates the desired review voice—a principal engineer with teaching instincts who explains the why behind findings. This is a coherent, well-articulated directive and well within the schema's 250-character limit (~110 chars used).
18-18: Verify the intent behind expanding auto-review scope to all branches.The
base_branches: [".*"]setting is a behavioral shift: it expands CodeRabbit's auto-review from the default branch only (the implicit default) to all branches in the repository. While this is valid per the schema, it's a material change in review coverage.Please confirm this aligns with your team's workflow, especially in the context of DC-5040's environment variable configuration goals. Is the intent to ensure consistent governance across feature branches and experimental work as well?
content/200-orm/500-reference/325-prisma-config-reference.mdx (1)
602-629: Consolidate duplicated "Loading environment variables" content from generating-prisma-client.mdx.This section (lines 602–629) is nearly verbatim with content in
010-generating-prisma-client.mdx(lines 127–154). For a reference file, it's appropriate to document this pattern, but consider:
- Option A: Extract the pattern into a shared partial/include and reference it from both files.
- Option B: Move the detailed how-to to the generating-prisma-client.mdx and make this reference file a brief summary with a link.
- Option C: If keeping both, add distinct context to each (e.g., explain the reference docs version covers type safety, while the quickstart version covers practical setup).
⛔ Skipped due to learnings
Learnt from: aidankmcalister Repo: prisma/docs PR: 7165 File: content/800-guides/550-test-guide.mdx:85-90 Timestamp: 2025-10-08T16:23:00.388Z Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.content/200-orm/200-prisma-client/000-setup-and-configuration/010-generating-prisma-client.mdx (1)
127-154: Content will be duplicated in the Prisma Config reference file (325-prisma-config-reference.mdx:602–629).The "Loading environment variables" section appears to be nearly identical in both files. Consider consolidating into a single canonical location and cross-linking, or clarifying the distinct audience/purpose of each. Duplication creates maintenance friction when the guidance needs to be updated.
⛔ Skipped due to learnings
Learnt from: aidankmcalister Repo: prisma/docs PR: 7165 File: content/800-guides/550-test-guide.mdx:85-90 Timestamp: 2025-10-08T16:23:00.388Z Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx
Redirects per inputRedirects in 100-getting-started/01-quickstart-prismaPostgres.mdx
Redirects in 100-getting-started/01-quickstart-sqlite.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases-typescript-prismaPostgres.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/100-connect-your-database-node-planetscale.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/100-connect-your-database-node-sqlserver.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/100-connect-your-database-typescript-planetscale.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/100-connect-your-database-typescript-prismaPostgres.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/100-connect-your-database-typescript-sqlserver.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/110-relational-databases/300-next-steps.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/120-mongodb-node-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/120-mongodb-typescript-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/120-mongodb/100-connect-your-database-node-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/120-mongodb/100-connect-your-database-typescript-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/100-start-from-scratch/120-mongodb/300-next-steps.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/110-relational-databases/100-connect-your-database-node-planetscale.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/110-relational-databases/100-connect-your-database-node-sqlserver.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/110-relational-databases/100-connect-your-database-typescript-planetscale.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/110-relational-databases/100-connect-your-database-typescript-sqlserver.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/110-relational-databases/300-next-steps.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/120-mongodb-node-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/120-mongodb-typescript-mongodb.mdx
Redirects in 100-getting-started/02-setup-prisma/200-add-to-existing-project/120-mongodb/300-next-steps.mdx
Redirects in 100-getting-started/03-prisma-postgres/100-from-the-cli.mdx
Redirects in 100-getting-started/03-prisma-postgres/110-import-from-existing-database-postgresql.mdx
Redirects in 100-getting-started/03-prisma-postgres/115-import-from-existing-database-mysql.mdx
Redirects in 100-getting-started/03-prisma-postgres/120-upgrade-from-early-access.mdx
Redirects in 200-orm/050-overview/100-introduction/200-why-prisma.mdx
Redirects in 200-orm/050-overview/100-introduction/250-should-you-use-prisma.mdx
Redirects in 200-orm/050-overview/300-prisma-in-your-stack/01-rest.mdx
Redirects in 200-orm/050-overview/300-prisma-in-your-stack/02-graphql.mdx
Redirects in 200-orm/050-overview/300-prisma-in-your-stack/03-fullstack.mdx
Redirects in 200-orm/050-overview/500-databases/200-database-drivers.mdx
Redirects in 200-orm/050-overview/500-databases/300-postgresql.mdx
Redirects in 200-orm/050-overview/500-databases/400-mysql.mdx
Redirects in 200-orm/050-overview/500-databases/600-mongodb.mdx
Redirects in 200-orm/050-overview/500-databases/800-sql-server/020-sql-server-local.mdx
Redirects in 200-orm/050-overview/500-databases/850-planetscale.mdx
Redirects in 200-orm/050-overview/500-databases/880-supabase.mdx
Redirects in 200-orm/050-overview/500-databases/890-neon.mdx
Redirects in 200-orm/050-overview/500-databases/900-turso.mdx
Redirects in 200-orm/050-overview/500-databases/950-cloudflare-d1.mdx
Redirects in 200-orm/100-prisma-schema/10-overview/03-generators.mdx
Redirects in 200-orm/100-prisma-schema/10-overview/04-location.mdx
Redirects in 200-orm/100-prisma-schema/20-data-model/10-models.mdx
Redirects in 200-orm/100-prisma-schema/20-data-model/40-views.mdx
Redirects in 200-orm/200-prisma-client/000-setup-and-configuration/010-generating-prisma-client.mdx
Redirects in 200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/200-pgbouncer.mdx
Redirects in 200-orm/200-prisma-client/000-setup-and-configuration/200-read-replicas.mdx
Redirects in 200-orm/200-prisma-client/100-queries/050-filtering-and-sorting.mdx
Redirects in 200-orm/200-prisma-client/100-queries/058-transactions.mdx
Redirects in 200-orm/200-prisma-client/100-queries/061-custom-validation.mdx
Redirects in 200-orm/200-prisma-client/100-queries/070-case-sensitivity.mdx
Redirects in 200-orm/200-prisma-client/150-using-raw-sql/200-raw-queries.mdx
Redirects in 200-orm/200-prisma-client/200-special-fields-and-types/index.mdx
Redirects in 200-orm/200-prisma-client/300-client-extensions/200-extension-examples.mdx
Redirects in 200-orm/200-prisma-client/300-client-extensions/500-middleware/index.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/101-traditional/225-deploy-to-render.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/101-traditional/325-deploy-to-railway.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/201-serverless/300-deploy-to-vercel.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/201-serverless/500-deploy-to-netlify.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/301-edge/100-overview.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/301-edge/450-deploy-to-cloudflare.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/301-edge/485-deploy-to-vercel.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/301-edge/550-deploy-to-deno-deploy.mdx
Redirects in 200-orm/200-prisma-client/500-deployment/550-deploy-database-changes-with-prisma-migrate.mdx
Redirects in 200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx
Redirects in 200-orm/500-reference/100-prisma-schema-reference.mdx
Redirects in 200-orm/500-reference/250-error-reference.mdx
Redirects in 200-orm/500-reference/400-system-requirements.mdx
Redirects in 200-orm/500-reference/500-preview-features/050-client-preview-features.mdx
Redirects in 200-orm/800-more/100-under-the-hood/100-engines.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/200-upgrading-versions/600-upgrading-to-prisma-5/index.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/03-upgrading-the-prisma-layer-mysql.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/03-upgrading-the-prisma-layer-postgresql.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/04-upgrading-nexus-prisma-to-nexus.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/05-upgrading-prisma-binding-to-nexus.mdx
Redirects in 200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/08-upgrade-from-mongodb-beta.mdx
Redirects in 200-orm/800-more/350-ai-tools/100-cursor.mdx
Redirects in 200-orm/800-more/350-ai-tools/300-windsurf.mdx
Redirects in 200-orm/800-more/350-ai-tools/400-github-copilot.mdx
Redirects in 200-orm/800-more/350-ai-tools/index.mdx
Redirects in 200-orm/800-more/400-comparisons/01-prisma-and-typeorm.mdx
Redirects in 200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx
Redirects in 200-orm/800-more/500-development-environment/200-editor-setup.mdx
Redirects in 200-orm/800-more/600-help-and-troubleshooting/050-dataguide/03-date-types.mdx
Redirects in 200-orm/800-more/600-help-and-troubleshooting/050-dataguide/04-connecting-to-postgresql-databases.mdx
Redirects in 200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx
Redirects in 200-orm/800-more/600-help-and-troubleshooting/800-check-constraints.mdx
Redirects in 250-postgres/100-introduction/250-overview.mdx
Redirects in 250-postgres/300-database/350-caching.mdx
Redirects in 250-postgres/300-database/525-postgres-extensions.mdx
Redirects in 250-postgres/350-integrations/100-netlify.mdx
Redirects in 250-postgres/350-integrations/200-vercel.mdx
Redirects in 250-postgres/350-integrations/300-idx.mdx
|
🍈 Lychee Link Check Report
📊 Results Overview
|
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx
|
🍈 Lychee Link Check Report
📊 Results Overview
|
Summary by CodeRabbit
New Features
Chores
Documentation