fix: document and consolidate DB_* env vars for knexfile - #574
Open
amujapromise9-dev wants to merge 4 commits into
Open
Conversation
|
@amujapromise9-dev Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR fixes the undocumented
DB_*environment variables insrc/knexfile.tsby addingDB_HOST,DB_PORT,DB_NAME,DB_USER, andDB_PASSWORDto.env.exampleanddocs/SETUP.md, and routing them throughsrc/config.ts— the codebase's single module for environment configuration. This makes the migration system's Postgres connection settings visible, configurable, and consistent with every other environment variable in the app.Related Issue
Closes #
Changes
📝 Environment Variable Documentation
[ADD]
.env.exampleDB_HOST,DB_PORT,DB_NAME,DB_USER, andDB_PASSWORDwith sensible defaults/placeholders for local Postgres development.[ADD]
docs/SETUP.mdDB_*variables to the "Environment Variables Reference" table with descriptions and example values.🔧 Config Consolidation
[MODIFY]
src/config.tsDB_HOST,DB_PORT,DB_NAME,DB_USER, andDB_PASSWORDfields to the config object, following the existing pattern used byPORT,RPC_URL, etc.[MODIFY]
src/knexfile.tsprocess.env.DB_*reads with the consolidated config module, so all environment configuration flows through a single source of truth.Verification Results
DB_HOST/DB_PORT/DB_NAME/DB_USER/DB_PASSWORDdocumented in.env.exampleDB_*variables added todocs/SETUP.mdenvironment variable tableDB_*variables routed throughsrc/config.tsdbsettings;knexfile.tsconsumes themgetKnexInstance()produces identical Postgres config from consolidated sourceCloses #465