Skip to content

Commit 85a0cef

Browse files
committed
Improve README
Signed-off-by: Daniel González Lopes <[email protected]>
1 parent da6d1b7 commit 85a0cef

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# run-k6-action
22

3+
This action allows you to easily execute k6 tests as part of your GitHub Actions workflow. It has support for globs, parallel execution, and fail-fast.
4+
5+
36
## Usage
47

58
See [action.yml](action.yaml).
@@ -26,6 +29,8 @@ jobs:
2629
2730
#### Grafana Cloud k6 integration
2831
32+
To send the results to Grafana Cloud k6, you need to set the GCk6 environment variables.
33+
2934
```yaml
3035
on:
3136
push:
@@ -47,7 +52,7 @@ jobs:
4752
./tests/protocol*.js
4853
```
4954
50-
When the Cloud environment variables are set, by default, the action will run k6 locally and send the results to Grafana Cloud k6. If you want to run the tests in our Cloud instances, you can change the `cloud-run-locally` input to `false`:
55+
By default, the action will run k6 locally and send the results to Grafana Cloud k6. If you want to run the tests in our Cloud instances, you need to change the `cloud-run-locally` input to `false`:
5156

5257
```yaml
5358
- uses: grafana/run-k6-action@v1

0 commit comments

Comments
 (0)