|
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | 4 | <a href="https://usetusk.ai"> |
5 | | - <img src="./static/images/tusk.png" width="200" title="Tusk"> |
| 5 | + <img src="./static/images/tusk.png" width="200" title="Tusk" alt="Tusk"> |
6 | 6 | </a> |
7 | 7 | </p> |
8 | 8 |
|
|
15 | 15 |
|
16 | 16 | </div> |
17 | 17 |
|
18 | | -Tusk is an AI testing platform that helps you catch blind spots, surface edge cases cases, and write verified tests for your commits. |
| 18 | +> [!NOTE] |
| 19 | +> For most users, we recommend following our [guide to set up your sandboxed test execution environment](https://docs.usetusk.ai/automated-tests/test-execution-environments). |
| 20 | +> If you have any questions, contact us at <support@usetusk.ai>. |
19 | 21 |
|
20 | | -This GitHub Action facilitates running Tusk-generated tests on Github runners. |
| 22 | +Tusk is an AI testing platform that helps you catch blind spots, surface edge cases cases, and write verified tests for your commits. This GitHub Action facilitates running Tusk-generated tests on Github runners. |
21 | 23 |
|
22 | | -## Usage |
23 | | - |
24 | | -Onboard to the Tusk platform: |
| 24 | +New to Tusk? Check out our [main page](https://www.usetusk.ai/) |
| 25 | +or [docs](https://docs.usetusk.ai/automated-tests/overview). |
25 | 26 |
|
26 | | -- Set your team up on Tusk [[docs](https://docs.usetusk.ai/automated-tests/onboarding)]. |
27 | | -- Configure and validate your test execution environment (including a workflow that uses this action) through the setup wizard [[docs](https://docs.usetusk.ai/automated-tests/self-serve)]. |
| 27 | +## Usage |
28 | 28 |
|
29 | 29 | When you push new commits, Tusk runs against your commit changes and generates tests. To ensure that test scenarios are meaningful and verified, Tusk will start this workflow and provision a runner (with a unique `runId`), using it as an ephemeral sandbox to run tests against your specific setup and dependencies. Essentially, this action polls for live commands emitted by Tusk based on the progress of the run, executes them, and sends the results back to Tusk for further processing. |
30 | 30 |
|
@@ -170,7 +170,7 @@ For calculating test coverage gains, we support Pytest and Jest at the moment. |
170 | 170 |
|
171 | 171 | Example: |
172 | 172 |
|
173 | | - ``` |
| 173 | + ```text |
174 | 174 | npm run test {{testFilePaths}} -- --coverage --coverageReporters=json-summary --coverageDirectory=./coverage |
175 | 175 | ``` |
176 | 176 |
|
@@ -259,4 +259,4 @@ You will also need to set the number of sandboxes to use in the Tusk app. Tusk w |
259 | 259 |
|
260 | 260 | ## Contact |
261 | 261 |
|
262 | | -Need help? Drop us an email at support@usetusk.ai. |
| 262 | +Need help? Drop us an email at <support@usetusk.ai>. |
0 commit comments