Skip to content

Commit 498803f

Browse files
committed
docs: augment comments in config/env.ts
1 parent 29d9c21 commit 498803f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

config/env.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// TODO(serhalp): Extract most of this module to https://github.com/unjs/std-env.
2+
13
import Git from 'simple-git'
24
import * as process from 'node:process'
35

@@ -27,12 +29,14 @@ export const gitBranch = process.env.BRANCH || process.env.VERCEL_GIT_COMMIT_REF
2729

2830
/**
2931
* Environment variable `CONTEXT` provided by Netlify.
32+
* `dev`, `production`, `deploy-preview`, `branch-deploy`, `preview-server`, or a branch name
3033
* @see {@link https://docs.netlify.com/build/configure-builds/environment-variables/#build-metadata}
3134
*
3235
* Environment variable `VERCEL_ENV` provided by Vercel.
36+
* `production`, `preview`, or `development`
3337
* @see {@link https://vercel.com/docs/environment-variables/system-environment-variables#VERCEL_ENV}
3438
*
35-
* Whether triggered by PR, `deploy-preview` or `dev`.
39+
* Whether this is some sort of preview environment.
3640
*/
3741
export const isPreview =
3842
isPR ||

0 commit comments

Comments
 (0)