docs: clarify environment variables behavior #36620
Merged
Conversation
This file contains 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
balazsorban44
requested review from
timneutkens,
ijjk,
shuding,
styfle,
huozhi,
padmaia and
leerob
as code owners
styfle
reviewed
May 2, 2022
| @@ -46,8 +46,7 @@ export async function getStaticProps() { | |||
| } | |||
| ``` | |||
|
|
|||
| > **Note**: In order to keep server-only secrets safe, Next.js replaces `process.env.*` with the correct values | |||
| > at build time. This means that `process.env` is not a standard JavaScript object, so you’re not able to | |||
| > **Note**: In order to keep server-only secrets safe, environment variables are evaluated at build time, so only environment variables *actually* used will be included. This means that `process.env` is not a standard JavaScript object, so you’re not able to | |||
There was a problem hiding this comment.
This is less clear because "evaluated" is not the same as "replaced".
Typically eval allows dynamic usage but this is pure static analysis. The syntax is very specific.
There was a problem hiding this comment.
You are right. Any suggestion on how we can make it more clear? 🤔
There was a problem hiding this comment.
I think this entire page needs to be reworked but we can ship this for now
styfle
previously approved these changes
May 3, 2022
ijjk
approved these changes
May 22, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Based on #36551 (comment) making the docs more clear which also aligns with the wording of Environment Variables in Middlerware: https://nextjs.org/docs/api-reference/next/server#how-do-i-access-environment-variables
See also: #20869 (comment)
Bug
fixes #numbercontributing.mdFeature
fixes #numbercontributing.mdDocumentation / Examples
yarn lint