Skip to content

doc(prisma-config): update example using environment variables#7203

Merged
mhartington merged 1 commit intomainfrom
mhartington/DA-5714
Oct 20, 2025
Merged

doc(prisma-config): update example using environment variables#7203
mhartington merged 1 commit intomainfrom
mhartington/DA-5714

Conversation

@mhartington
Copy link
Member

@mhartington mhartington commented Oct 20, 2025

Update prisma-config example for using environment variables

Summary by CodeRabbit

  • Documentation
    • Expanded guidance for loading environment variables when using prisma.config.ts, covering Node, Deno, and Bun.
    • Added explicit command-line examples (including --env-file) and a tabbed Node/Deno example block.
    • Included Node v18/v19 guidance to install and import dotenv plus a sample usage for PrismaConfig.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 20, 2025

Walkthrough

Expanded documentation on loading environment variables across Node, Deno, and Bun runtimes with explicit command-line examples, a TabbedContent block containing runtime-specific code samples, and added guidance for Node v18/v19 using the dotenv package when using prisma.config.ts.

Changes

Cohort / File(s) Summary
Documentation update
content/200-orm/500-reference/325-prisma-config-reference.mdx
Replaced a brief note with detailed, runtime-specific guidance for loading environment variables when using prisma.config.ts. Added command-line examples for Node and Deno (--env-file), noted Bun auto-load behavior, included TabbedContent with Node and Deno usage examples, and added instructions for Node v18/v19 to install and import dotenv with a code example for PrismaConfig.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "doc(prisma-config): update example using environment variables" is directly related to the main change in the changeset. The file modified (prisma-config-reference.mdx) was updated with expanded guidance on loading environment variables across different runtimes (Node, Deno, and Bun), replacing a terse note with detailed steps and examples. The title clearly identifies this as a documentation update and accurately reflects the core objective of improving the environment variables example in the prisma-config reference. The title is also concise, specific, and void of vague terminology.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89a6f8c and a53192d.

📒 Files selected for processing (1)
  • content/200-orm/500-reference/325-prisma-config-reference.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • content/200-orm/500-reference/325-prisma-config-reference.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 internal links
  • GitHub Check: runner / linkspector

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dba7ffd and 89a6f8c.

📒 Files selected for processing (1)
  • content/200-orm/500-reference/325-prisma-config-reference.mdx (1 hunks)
🔇 Additional comments (1)
content/200-orm/500-reference/325-prisma-config-reference.mdx (1)

357-397: Documentation expansion for environment variables is clear and well-structured.

The expanded guidance effectively covers environment variable loading across Node, Deno, and Bun runtimes with appropriate examples and fallback instructions for Node <v20. The tabbed content organization and step-by-step dotenv setup are helpful additions. Once the Deno syntax is corrected, this section will provide good guidance for users.

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

  • This PR does not change any pages in a way that would require a redirect.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 20, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a53192d
Status: ✅  Deploy successful!
Preview URL: https://2d5ed968.docs-51g.pages.dev
Branch Preview URL: https://mhartington-da-5714.docs-51g.pages.dev

View logs

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.

2 participants