Skip to content

Commit b58bfe0

Browse files
authored
Add default value for inputs in readme
1 parent 7ce1393 commit b58bfe0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ It is a wrapper over `k6 run`, with support for globs, parallel execution, fail-
2222

2323
The following inputs can be used as `step.with` key:
2424

25-
| Name | Type | Required | Description
26-
| --- | --- | --- | --- |
27-
| `path` | string | `true` | Glob pattern to select one or multiple test scripts to run. <br/> e.g. `./tests/api*.js` <br/> One can also supply multiple patterns by separating them with new line.<br/><code>path: \|<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;./tests/api*.js<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;./tests/app*.js</code>
28-
| `cloud-run-locally` | boolean | `false` | If `true`, the tests are executed locally and the results are uploaded to Grafana Cloud k6
29-
| `parallel` | boolean | `false` | If `true` and multiple tests are executed, all them run in parallel.
30-
| `fail-fast` | boolean | `false` | If `true`, the whole pipeline fails as soon as the first test fails
31-
| `flags` | string | `false` | Additional flags to be passed on to the `k6 run` command.<br/>e.g. `--vus 10 --duration 20s`
32-
| `cloud-comment-on-pr` | boolean | `false` | If `true`, the workflow comments a link to the cloud test run on the pull request (if present)
33-
| `only-verify-scripts` | boolean | `false` | If `true`, only check if the test scripts are valid and skip the test execution'
25+
| Name | Type | Required | Default | Description
26+
| --- | --- | --- | --- | --- |
27+
| `path` | string | `true` | `''` | Glob pattern to select one or multiple test scripts to run. <br/> e.g. `./tests/api*.js` <br/> One can also supply multiple patterns by separating them with new line.<br/><code>path: \|<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;./tests/api*.js<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;./tests/app*.js</code>
28+
| `cloud-run-locally` | boolean | `false` | `true` | If `true`, the tests are executed locally and the results are uploaded to Grafana Cloud k6
29+
| `parallel` | boolean | `false` | `false` | If `true` and multiple tests are executed, all them run in parallel.
30+
| `fail-fast` | boolean | `false` | `false` | If `true`, the whole pipeline fails as soon as the first test fails
31+
| `flags` | string | `false` | `''` | Additional flags to be passed on to the `k6 run` command.<br/>e.g. `--vus 10 --duration 20s`
32+
| `cloud-comment-on-pr` | boolean | `false` | `true` | If `true`, the workflow comments a link to the cloud test run on the pull request (if present)
33+
| `only-verify-scripts` | boolean | `false` | `false` | If `true`, only check if the test scripts are valid and skip the test execution'
3434

3535
## Usage
3636

0 commit comments

Comments
 (0)