From 93545ea3dbb86260ab510d12c7dac9a277162ef8 Mon Sep 17 00:00:00 2001 From: Andrew Goldis Date: Wed, 10 Jul 2024 14:06:37 -0700 Subject: [PATCH] chore: .. [skip ci] --- packages/cmd/README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/packages/cmd/README.md b/packages/cmd/README.md index 979d5ac..081efbc 100644 --- a/packages/cmd/README.md +++ b/packages/cmd/README.md @@ -10,14 +10,14 @@ npm install @currents/cmd --save-dev ## Usage -- Generate test results with one of the reporters (see [documentation](https://docs.currents.dev) for the list of supporter reporters) +- Generate test results with one of the [supported](https://docs.currents.dev) reporters - Upload the results ```sh npx currents upload --project-id=xxx --key=yyy ``` -ℹī¸ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) (`--ci-build-id`) before using the tool in CI. +ℹī¸ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) before using `currents` in CI. It is **important** to set the `CI Build ID` explicitly using `--ci-build-id` option, if you are using CI sharding or multiple CI machines to parallelize your tests. If not set explicitly, the `CI Build ID` will be generated automatically if not set. ## Notes @@ -28,10 +28,6 @@ Obtain `--project-id` and [--key](https://docs.currents.dev/guides/record-key) f - use `process.env.CURRENTS_REPORT_DIR` or `--reportDir` to read the results previosly generated by one of supported reporters, otherwise - use the most recently created directory named as `.currents-report-[timestamp]-[uuidv4()]` in the current working directory -> ℹī¸ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) before using `currents` in CI. It is **important** to set the `CI Build ID` explicitly if you are using sharding or multiple machines for the same test run. - -> ℹī¸ The `CI Build ID` will be generated automatically if not set. - ## Configuration Please note that all options apart from `--project-id` and `--key` are optional.