Skip to content

Add comments to .env about applicability of the environment variables#453

Open
samdark wants to merge 2 commits intomasterfrom
docker
Open

Add comments to .env about applicability of the environment variables#453
samdark wants to merge 2 commits intomasterfrom
docker

Conversation

@samdark
Copy link
Member

@samdark samdark commented Mar 9, 2026

Q A
Is bugfix?
New feature?
Breaks BC?
Fixed issues -

Copilot AI review requested due to automatic review settings March 9, 2026 21:45
@samdark samdark added the type:docs Documentation label Mar 9, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds clarifying header comments to Docker environment variable files to document where variables are expected to be visible (Compose interpolation vs container/app runtime).

Changes:

  • Add header comments to docker/dev/.env, docker/test/.env, and docker/prod/.env about variables being available in the app/container rather than compose.yml.
  • Add a header comment to docker/.env describing variable applicability.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
docker/test/.env Adds header comment clarifying intended scope of test env vars.
docker/prod/.env Adds header comment clarifying intended scope of prod env vars.
docker/dev/.env Adds header comment clarifying intended scope of dev env vars.
docker/.env Adds header comment about variable scope (currently misleading vs actual Compose behavior).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docker/.env Outdated
Comment on lines +1 to +2
# Variables are available in both app and compose.yml.

Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

The new header comment is misleading: variables in this file are used by Make/Compose for interpolation (e.g., DEV_PORT/PROD_HOST), but they are not automatically injected into the app container environment unless explicitly passed via environment: or an env_file: entry. Please reword to reflect that these are Compose/Make variables (or document how they become available inside the container if that’s intended).

Suggested change
# Variables are available in both app and compose.yml.
# Variables in this file are used by Docker Compose/Make for interpolation (e.g. in compose.yml);
# they are not automatically available inside containers unless explicitly passed via `environment:` or an `env_file:`.

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Mar 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.96%. Comparing base (71d3a0f) to head (cef41ca).

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #453   +/-   ##
=========================================
  Coverage     76.96%   76.96%           
  Complexity       29       29           
=========================================
  Files            11       11           
  Lines           178      178           
=========================================
  Hits            137      137           
  Misses           41       41           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants