Skip to content

Commit

Permalink
debug: content removal
Browse files Browse the repository at this point in the history
  • Loading branch information
plyr4 committed Jan 15, 2025
1 parent c9ab92f commit a516a1c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,12 @@ export const options = {
> Any values set from a file take precedence over values set from the environment.

The following parameters are used to configure the image:

| Name | Description | Required | Default |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- |
| `script_path` | path to the k6 script file. must be a JavaScript file satisfying the pattern `??`. | `true` | `N/A` |
| `output_path` | path to the output file that will be created. directories will be created as necessary. if empty, no output file will be generated. must be a JSON file satisfying the pattern `^(\./\|(\.\./)+)?[a-zA-Z0-9-_/]*[a-zA-Z0-9]\.json$`. | `false` | `N/A` |
| `setup_script_path` | path to an optional setup script file to be run before tests. must be a shell script (sh or bash) with execute permissions matching the pattern `^(\./\|(\.\./)+)?[a-zA-Z0-9-_/]*[a-zA-Z0-9]\.sh$`. | `false` | `N/A` |
| `fail_on_threshold_breach` | if `false`, the pipeline step will not fail even if thresholds are breached. | `false` | `true` |
| `projektor_compat_mode` | if `true`, output will be generated with the `--summary-output` flag instead of the `--out` flag. this is necessary for results uploaded to a [Projektor](https://projektor.dev/) server. | `false` | `false` |
| `log_progress` | if `true`, k6 progress bar output will print to the Vela pipeline. Not recommended for numerous or long-running tests, as logging becomes excessive. | `false` | `false` |

0 comments on commit a516a1c

Please sign in to comment.