From 52744d95fc401194d193c256a5df50e34d20303f Mon Sep 17 00:00:00 2001 From: Manju <150487347+cskmnrpt@users.noreply.github.com> Date: Fri, 13 Sep 2024 13:04:06 +0530 Subject: [PATCH] Update README.md Changed default value for `QASE_MODE` to `off`. Changed default value for `QASE_ENVIRONMENT` to undefined. --- qase-javascript-commons/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/qase-javascript-commons/README.md b/qase-javascript-commons/README.md index ed126112..f2072de6 100644 --- a/qase-javascript-commons/README.md +++ b/qase-javascript-commons/README.md @@ -34,10 +34,10 @@ All configuration options are listed in the table below: | Description | Config file | Environment variable | Default value | Required | Possible values | |----------------------------------------------------------------------------------------------------------------------------|----------------------------|---------------------------------|-----------------------------------------|----------|----------------------------| | **Common** | | | | | | -| Mode of reporter | `mode` | `QASE_MODE` | `testops` | No | `testops`, `report`, `off` | +| Mode of reporter | `mode` | `QASE_MODE` | `off` | No | `testops`, `report`, `off` | | Fallback mode of reporter | `fallback` | `QASE_FALLBACK` | `off` | No | `testops`, `report`, `off` | -| Environment | `environment` | `QASE_ENVIRONMENT` | `local` | No | Any string | -| Root suite | `rootSuite` | `QASE_ROOT_SUITE` | | No | Any string | +| Environment | `environment` | `QASE_ENVIRONMENT` | undefined | No | Any string | +| Root suite | `rootSuite` | `QASE_ROOT_SUITE` | undefined | No | Any string | | Enable debug logs | `debug` | `QASE_DEBUG` | `False` | No | `True`, `False` | | Enable capture logs from `stdout` and `stderr` | `testops.defect` | `QASE_CAPTURE_LOGS` | `False` | No | `True`, `False` | | **Qase Report configuration** | | | | | | @@ -45,15 +45,15 @@ All configuration options are listed in the table below: | Path to save the report | `report.connection.path` | `QASE_REPORT_CONNECTION_PATH` | `./build/qase-report` | | | | Local report format | `report.connection.format` | `QASE_REPORT_CONNECTION_FORMAT` | `json` | | `json`, `jsonp` | | **Qase TestOps configuration** | | | | | | -| Token for [API access](https://developers.qase.io/#authentication) | `testops.api.token` | `QASE_TESTOPS_API_TOKEN` | | Yes | Any string | +| Token for [API access](https://developers.qase.io/#authentication) | `testops.api.token` | `QASE_TESTOPS_API_TOKEN` | undefined | Yes | Any string | | Qase API host. For enterprise users, specify full address: `api-example.qase.io` | `testops.api.host` | `QASE_TESTOPS_API_HOST` | `qase.io` | No | Any string | | Qase enterprise environment | `testops.api.enterprise` | `QASE_TESTOPS_API_ENTERPRISE` | `False` | No | `True`, `False` | -| Code of your project, which you can take from the URL: `https://app.qase.io/project/DEMOTR` - `DEMOTR` is the project code | `testops.project` | `QASE_TESTOPS_PROJECT` | | Yes | Any string | -| Qase test run ID | `testops.run.id` | `QASE_TESTOPS_RUN_ID` | | No | Any integer | +| Code of your project, which you can take from the URL: `https://app.qase.io/project/DEMOTR` - `DEMOTR` is the project code | `testops.project` | `QASE_TESTOPS_PROJECT` | undefined | Yes | Any string | +| Qase test run ID | `testops.run.id` | `QASE_TESTOPS_RUN_ID` | undefined | No | Any integer | | Qase test run title | `testops.run.title` | `QASE_TESTOPS_RUN_TITLE` | `Automated run ` | No | Any string | | Qase test run description | `testops.run.description` | `QASE_TESTOPS_RUN_DESCRIPTION` | ` automated run` | No | Any string | | Qase test run complete | `testops.run.complete` | `QASE_TESTOPS_RUN_COMPLETE` | `True` | | `True`, `False` | -| Qase test plan ID | `testops.plan.id` | `QASE_TESTOPS_PLAN_ID` | | No | Any integer | +| Qase test plan ID | `testops.plan.id` | `QASE_TESTOPS_PLAN_ID` | undefined | No | Any integer | | Size of batch for sending test results | `testops.batch.size` | `QASE_TESTOPS_BATCH_SIZE` | `200` | No | Any integer | | Enable defects for failed test cases | `testops.defect` | `QASE_TESTOPS_DEFECT` | `False` | No | `True`, `False` |