From 3d9b2c4350e20b2331af2f84457e48a7bf67e2ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krystian=20Sowi=C5=84ski?= <88927709+plumcoding@users.noreply.github.com> Date: Mon, 27 Feb 2023 07:54:23 +0100 Subject: [PATCH] Update docs regards regards relative paths --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index afb6f81..738c7e4 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Reporter options should also be strings exception for suiteNameTemplate, classNa | Environment Variable Name | Reporter Config Name| Description | Default | Possible Injection Values |---|---|---|---|---| | `JEST_SUITE_NAME` | `suiteName` | `name` attribute of `` | `"jest tests"` | N/A -| `JEST_JUNIT_OUTPUT_DIR` | `outputDirectory` | Directory to save the output. | `process.cwd()` | N/A +| `JEST_JUNIT_OUTPUT_DIR` | `outputDirectory` | Directory to save the output. Relative path outside of project root (e.g. in monorepos) has to be prefixed with `` literal, e.g. `/../coverage` | `process.cwd()` | N/A | `JEST_JUNIT_OUTPUT_NAME` | `outputName` | File name for the output. | `"junit.xml"` | N/A | `JEST_JUNIT_OUTPUT_FILE` | `outputFile` | Fullpath for the output. If defined, `outputDirectory` and `outputName` will be overridden | `undefined` | N/A | `JEST_JUNIT_UNIQUE_OUTPUT_NAME` | `uniqueOutputName` | Create unique file name for the output leveraging the `outputName` as a prefix if given `${outputName}-${uuid}.xml` or a default of `junit-${uuid}.xml` if `outputName` is not specified, overrides `outputName` | `false` | N/A