|
2 | 2 |
|
3 | 3 | # webcontainer-ecosystem-ci |
4 | 4 |
|
5 | | -This repository is used to run tests for WebContainer ecosystem projects |
| 5 | +This repository is used to run tests for WebContainer ecosystem projects. |
6 | 6 |
|
7 | | -## Github workflow |
| 7 | +## GitHub workflow |
8 | 8 |
|
9 | 9 | ### Scheduled |
10 | 10 |
|
11 | | -Workflows are sheduled to run automatically every Monday, Wednesday and Friday. |
| 11 | +Workflows are scheduled to run automatically every Monday, Wednesday and Friday. |
12 | 12 |
|
13 | 13 | ### Manually |
14 | 14 |
|
15 | | -- open [workflow](../../actions/workflows/ecosystem-ci.yml) |
16 | | -- click 'Run workflow' button on top right of the list |
17 | | -- select suite to run in dropdown |
18 | | -- start workflow |
| 15 | +- Open [workflow](../../actions/workflows/ecosystem-ci.yml) |
| 16 | +- Click the 'Run workflow' button at the top right of the list |
| 17 | +- Select the suite to run in the dropdown |
| 18 | +- Start the workflow |
19 | 19 |
|
20 | 20 | ### Shell script |
21 | 21 |
|
22 | | -- clone this repo |
23 | | -- run `pnpm i` |
24 | | -- run `pnpm test` to run all suites |
25 | | -- or `pnpm test <suitename>` to select a suite |
26 | | -- or `tsx ecosystem-ci.ts` |
| 22 | +- Clone this repo |
| 23 | +- Run `pnpm i` |
| 24 | +- Run `pnpm test` to execute all suites |
| 25 | +- Or `pnpm test <suitename>` to select a specific suite |
| 26 | +- Or `tsx ecosystem-ci.ts` |
27 | 27 |
|
28 | 28 | You can pass `--release <version>` to select a specific `@webcontainer/api` version to use. |
29 | 29 |
|
30 | | -The repositories are checked out into `workspace` subdirectory as shallow clones |
| 30 | +The repositories are checked out into the `workspace` subdirectory as shallow clones. |
31 | 31 |
|
32 | 32 | ## How to add a new integration test |
33 | 33 |
|
34 | | -- check out the existing [tests](./tests) and add one yourself. Thanks to some utilities it is really easy |
35 | | -- once you are confidente the suite works, add it to the lists of suites in the [workflows](../../actions/) |
| 34 | +- Check out the existing [tests](./tests) and add one yourself. Thanks to some utilities, it is really easy |
| 35 | +- Once you are confidente the suite works, add it to the lists of suites in the [workflows](../../actions/) |
36 | 36 |
|
37 | 37 | ## Credits |
38 | 38 |
|
39 | | -This project is inspired and based on: |
| 39 | +This project is inspired by and based on: |
40 | 40 |
|
41 | 41 | - https://github.com/vitest-dev/vitest-ecosystem-ci |
42 | 42 | - https://github.com/vitejs/vite-ecosystem-ci |
0 commit comments