From f665930bb52dc86a79272eec212b4c028da92e66 Mon Sep 17 00:00:00 2001 From: stdavis Date: Tue, 13 Oct 2020 11:15:34 -0600 Subject: [PATCH 1/5] docs: add environment variables page Closes #8856 --- docs/EnvironmentVariables.md | 14 ++++++++++++++ website/sidebars.json | 3 ++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/EnvironmentVariables.md diff --git a/docs/EnvironmentVariables.md b/docs/EnvironmentVariables.md new file mode 100644 index 000000000000..fb50c3e72d08 --- /dev/null +++ b/docs/EnvironmentVariables.md @@ -0,0 +1,14 @@ +--- +id: environment-variables +title: Environment Variables +--- + +Jest sets the following environment variables: + +### `NODE_ENV` + +Set to `'test'` if it's not already set to something else. + +### `JEST_WORKER_ID` + +Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/sidebars.json b/website/sidebars.json index 3c4cc29d4399..1cb762c601d6 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -39,7 +39,8 @@ "mock-function-api", "jest-object", "configuration", - "cli" + "cli", + "environment-variables" ] } } From 154b7beacebc4b82b65896d04f2d5dfd2e8a5820 Mon Sep 17 00:00:00 2001 From: stdavis Date: Tue, 13 Oct 2020 11:23:13 -0600 Subject: [PATCH 2/5] chore: add change log --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 31c286e796e2..f6b3b73185ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,8 @@ ### Chore & Maintenance +- `[docs]` Add page detailing environment variables set by Jest ([#10630](https://github.com/facebook/jest/pull/10630)) + ### Performance ## 26.5.3 From baa4fa6180d0737d267519a894786da481fa286a Mon Sep 17 00:00:00 2001 From: stdavis Date: Tue, 13 Oct 2020 13:56:11 -0600 Subject: [PATCH 3/5] docs: add environment variables pages to all api doc versions --- .../version-22.x/EnvironmentVariables.md | 15 +++++++++++++++ .../version-23.x/EnvironmentVariables.md | 15 +++++++++++++++ .../version-24.x/EnvironmentVariables.md | 15 +++++++++++++++ .../version-26.0/EnvironmentVariables.md | 15 +++++++++++++++ .../versioned_sidebars/version-22.x-sidebars.json | 3 ++- .../versioned_sidebars/version-23.x-sidebars.json | 3 ++- .../versioned_sidebars/version-24.x-sidebars.json | 3 ++- .../versioned_sidebars/version-26.0-sidebars.json | 3 ++- 8 files changed, 68 insertions(+), 4 deletions(-) create mode 100644 website/versioned_docs/version-22.x/EnvironmentVariables.md create mode 100644 website/versioned_docs/version-23.x/EnvironmentVariables.md create mode 100644 website/versioned_docs/version-24.x/EnvironmentVariables.md create mode 100644 website/versioned_docs/version-26.0/EnvironmentVariables.md diff --git a/website/versioned_docs/version-22.x/EnvironmentVariables.md b/website/versioned_docs/version-22.x/EnvironmentVariables.md new file mode 100644 index 000000000000..87ba1381f2e8 --- /dev/null +++ b/website/versioned_docs/version-22.x/EnvironmentVariables.md @@ -0,0 +1,15 @@ +--- +id: version-22.x-environment-variables +title: Environment Variables +original_id: environment-variables +--- + +Jest sets the following environment variables: + +### `NODE_ENV` + +Set to `'test'` if it's not already set to something else. + +### `JEST_WORKER_ID` + +Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_docs/version-23.x/EnvironmentVariables.md b/website/versioned_docs/version-23.x/EnvironmentVariables.md new file mode 100644 index 000000000000..2cbf0402e537 --- /dev/null +++ b/website/versioned_docs/version-23.x/EnvironmentVariables.md @@ -0,0 +1,15 @@ +--- +id: version-23.x-environment-variables +title: Environment Variables +original_id: environment-variables +--- + +Jest sets the following environment variables: + +### `NODE_ENV` + +Set to `'test'` if it's not already set to something else. + +### `JEST_WORKER_ID` + +Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_docs/version-24.x/EnvironmentVariables.md b/website/versioned_docs/version-24.x/EnvironmentVariables.md new file mode 100644 index 000000000000..16718bd1bd7c --- /dev/null +++ b/website/versioned_docs/version-24.x/EnvironmentVariables.md @@ -0,0 +1,15 @@ +--- +id: version-24.x-environment-variables +title: Environment Variables +original_id: environment-variables +--- + +Jest sets the following environment variables: + +### `NODE_ENV` + +Set to `'test'` if it's not already set to something else. + +### `JEST_WORKER_ID` + +Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_docs/version-26.0/EnvironmentVariables.md b/website/versioned_docs/version-26.0/EnvironmentVariables.md new file mode 100644 index 000000000000..ebef831503a9 --- /dev/null +++ b/website/versioned_docs/version-26.0/EnvironmentVariables.md @@ -0,0 +1,15 @@ +--- +id: version-26.0-environment-variables +title: Environment Variables +original_id: environment-variables +--- + +Jest sets the following environment variables: + +### `NODE_ENV` + +Set to `'test'` if it's not already set to something else. + +### `JEST_WORKER_ID` + +Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_sidebars/version-22.x-sidebars.json b/website/versioned_sidebars/version-22.x-sidebars.json index 5519b94c5267..630569168d5f 100644 --- a/website/versioned_sidebars/version-22.x-sidebars.json +++ b/website/versioned_sidebars/version-22.x-sidebars.json @@ -33,7 +33,8 @@ "version-22.x-mock-function-api", "version-22.x-jest-object", "version-22.x-configuration", - "version-22.x-cli" + "version-22.x-cli", + "version-22.x-environment-variables" ] } } diff --git a/website/versioned_sidebars/version-23.x-sidebars.json b/website/versioned_sidebars/version-23.x-sidebars.json index c681767309d2..de96dc37c761 100644 --- a/website/versioned_sidebars/version-23.x-sidebars.json +++ b/website/versioned_sidebars/version-23.x-sidebars.json @@ -36,7 +36,8 @@ "version-23.x-mock-function-api", "version-23.x-jest-object", "version-23.x-configuration", - "version-23.x-cli" + "version-23.x-cli", + "version-23.x-environment-variables" ] } } diff --git a/website/versioned_sidebars/version-24.x-sidebars.json b/website/versioned_sidebars/version-24.x-sidebars.json index b9317eec8d8d..70a7968ade02 100644 --- a/website/versioned_sidebars/version-24.x-sidebars.json +++ b/website/versioned_sidebars/version-24.x-sidebars.json @@ -38,7 +38,8 @@ "version-24.x-mock-function-api", "version-24.x-jest-object", "version-24.x-configuration", - "version-24.x-cli" + "version-24.x-cli", + "version-24.x-environment-variables" ] } } diff --git a/website/versioned_sidebars/version-26.0-sidebars.json b/website/versioned_sidebars/version-26.0-sidebars.json index c69d3ac005d8..d791b145a933 100644 --- a/website/versioned_sidebars/version-26.0-sidebars.json +++ b/website/versioned_sidebars/version-26.0-sidebars.json @@ -39,7 +39,8 @@ "version-26.0-mock-function-api", "version-26.0-jest-object", "version-26.0-configuration", - "version-26.0-cli" + "version-26.0-cli", + "version-26.0-environment-variables" ] } } From d2cc56bc21887f4f8fb1fbf6f5545b10336ce6d9 Mon Sep 17 00:00:00 2001 From: Simen Bekkhus Date: Wed, 14 Oct 2020 07:44:06 +0200 Subject: [PATCH 4/5] delete unused doc versions --- .../version-23.x/EnvironmentVariables.md | 15 --------------- .../version-24.x/EnvironmentVariables.md | 15 --------------- .../version-26.0/EnvironmentVariables.md | 15 --------------- 3 files changed, 45 deletions(-) delete mode 100644 website/versioned_docs/version-23.x/EnvironmentVariables.md delete mode 100644 website/versioned_docs/version-24.x/EnvironmentVariables.md delete mode 100644 website/versioned_docs/version-26.0/EnvironmentVariables.md diff --git a/website/versioned_docs/version-23.x/EnvironmentVariables.md b/website/versioned_docs/version-23.x/EnvironmentVariables.md deleted file mode 100644 index 2cbf0402e537..000000000000 --- a/website/versioned_docs/version-23.x/EnvironmentVariables.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: version-23.x-environment-variables -title: Environment Variables -original_id: environment-variables ---- - -Jest sets the following environment variables: - -### `NODE_ENV` - -Set to `'test'` if it's not already set to something else. - -### `JEST_WORKER_ID` - -Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_docs/version-24.x/EnvironmentVariables.md b/website/versioned_docs/version-24.x/EnvironmentVariables.md deleted file mode 100644 index 16718bd1bd7c..000000000000 --- a/website/versioned_docs/version-24.x/EnvironmentVariables.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: version-24.x-environment-variables -title: Environment Variables -original_id: environment-variables ---- - -Jest sets the following environment variables: - -### `NODE_ENV` - -Set to `'test'` if it's not already set to something else. - -### `JEST_WORKER_ID` - -Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. diff --git a/website/versioned_docs/version-26.0/EnvironmentVariables.md b/website/versioned_docs/version-26.0/EnvironmentVariables.md deleted file mode 100644 index ebef831503a9..000000000000 --- a/website/versioned_docs/version-26.0/EnvironmentVariables.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: version-26.0-environment-variables -title: Environment Variables -original_id: environment-variables ---- - -Jest sets the following environment variables: - -### `NODE_ENV` - -Set to `'test'` if it's not already set to something else. - -### `JEST_WORKER_ID` - -Each worker process is assigned a unique id (index-based that starts with `1`). This is set to `1` for all tests when [`runInBand`](CLI.md#--runinband) is set to true. From 99825028dc1226d18695579ed018ef0e8c0892bb Mon Sep 17 00:00:00 2001 From: Simen Bekkhus Date: Wed, 14 Oct 2020 07:44:36 +0200 Subject: [PATCH 5/5] move changelog entry --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c67c5d614eb0..4c8dad693ee8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,6 @@ ### Features -- `[docs]` Add step for fetching `backers.json` file in website setup docs ([#10631](https://github.com/facebook/jest/pull/10631)) - `[jest-cli, jest-config]` Add support for the `jest.config.ts` configuration file ([#10564](https://github.com/facebook/jest/pull/10564)) ### Fixes @@ -11,6 +10,7 @@ ### Chore & Maintenance +- `[docs]` Add step for fetching `backers.json` file in website setup docs ([#10631](https://github.com/facebook/jest/pull/10631)) - `[docs]` Add page detailing environment variables set by Jest ([#10630](https://github.com/facebook/jest/pull/10630)) ### Performance