Skip to content

Commit c3a3e02

Browse files
authored
docs(run-integration-test): Improve README (#63)
1 parent 736565e commit c3a3e02

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

run-integration-test/README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ The following strategies are currently available:
5959
need to add up to 100, but it is recommended to more easily gauge the probability.
6060
- `use-runner`: uses the specified `runner`.
6161

62-
Each profile can additionally specify test `options`, like `parallelism`, `test-suite` and
63-
`test-suite`.
62+
Each profile can additionally specify test `options`, like `beku-parallelism`, `beku-test-suite` and
63+
`beku-test`.
6464

6565
```yaml
6666
profiles:
@@ -74,14 +74,14 @@ profiles:
7474
- weight: 10
7575
runner: default-mixed
7676
options:
77-
parallelism: 1
77+
beku-parallelism: 1
7878
7979
smoke:
8080
strategy: use-runner
8181
runner: default-amd64
8282
options:
83-
test-suite: smoke
84-
parallelism: 2
83+
beku-test-suite: smoke
84+
beku-parallelism: 2
8585
```
8686

8787
## Inputs and Outputs
@@ -91,23 +91,26 @@ profiles:
9191

9292
### Inputs
9393

94-
- `test-mode` (required)
95-
- `test-mode-input` (required)
96-
- `test-suite` (optional)
97-
- `test` (optional)
98-
- `replicated-api-token` (required)
99-
- `interu-version` (optional)
100-
- `beku-version` (optional)
101-
- `kuttl-version` (optional)
102-
- `stackablectl-version` (optional)
94+
| Input | Required | Description |
95+
| ---------------------- | -------- | ---------------------------------------------------------------------- |
96+
| `replicated-api-token` | Yes | Replicated API Token, available via `secrets.REPLICATED_API_TOKEN` |
97+
| `test-mode` | Yes | Either run a `profile` or a `custom` test |
98+
| `test-mode-input` | Yes | The name of the profile or runner, based on the `test-mode` |
99+
| `test-suite` | No | The name of the BeKu test-suite (only used if running a `custom` test) |
100+
| `test` | No | The name of the BeKu test (only used if running a `custom` test) |
101+
| `interu-version` | No | The interu version used by the action |
102+
| `beku-version` | No | The beku version used by the action |
103+
| `kuttl-version` | No | The kubectl-kuttl version used by the action |
104+
| `stackablectl-version` | No | The stackablectl version used by the action |
103105

104106
### Outputs
105107

106-
- `start-time`
107-
- `end-time`
108-
- `health`: The health of the integration tests. Contains three comma-separated values: Slack emoji,
109-
GitHub emoji, and success rate.
110-
- `failed-tests`: A (potentially empty) plain text list of failed tests.
108+
| Output | Description |
109+
| ------ | ----------- |
110+
| `start-time` | The time the test started running, in the `%Y-%m-%dT%H:%M:%S` (eg. `2025-08-20T09:57:53`) format. |
111+
| `end-time` | The time the test completed, in the same format as above. |
112+
| `health` | The health of the integration tests. Contains three comma-separated values: Slack emoji, GitHub emoji, and success rate. |
113+
| `failed-tests` | A (potentially empty) plain text list of failed tests. |
111114

112115
[supported-clusters]: https://docs.replicated.com/vendor/testing-supported-clusters
113116
[run-integration-test]: ./action.yaml

0 commit comments

Comments
 (0)