Skip to content

Commit 1c4e27e

Browse files
Update README.md
1 parent f38258c commit 1c4e27e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ This action takes the following inputs to configure its behavior. You can see an
5555
- **description** : A string description of your test run. The description will be in the headers of the generated report and of any emails triggered by the test run.
5656
- **email_recipients** : A semi-colon delimited list of the email addresses for the recipients who will be emailed links to the triage report produced by this test run. If this parameter is not specified, emails will be sent to the default users set up for the test.
5757
- **additional_parameters** : A newline-seperated list of additional parameters to be sent to the test run.
58-
- **test_name**: An optional name for the test you are running. When specified the context of the status set on the git commit will be set to `continuous-testing/antithesis (test_name)` otherwise the default context used is `continuous-testing/antithesis`. This enables users to optionally run more than one antithesis test per commit.
58+
- **test_name**: An optional name for the test you are running. When specified, the git commit's status context will be `continuous-testing/antithesis (test_name)`. Otherwise, the default context is `continuous-testing/antithesis`. This enables users to run more than one Antithesis test per commit.
5959

6060
### FAQs
6161

62-
#### How to run multiple tests on the same commit using this GitHub Action?
62+
#### How can I run multiple tests on the same commit using this GitHub Action?
6363

6464
To run multiple tests from the same commit using this GitHub action, you can set a unique `test_name` parameter when calling the action. This will create a unique git commit status context for every unique `test_name` specified. The example below shows what this will look like if 2 tests were ran for a commit one called _first test_ and the other called _second test_.
6565

0 commit comments

Comments
 (0)