Skip to content

Commit f1d1ab2

Browse files
committed
chore: add examples explanation
1 parent dea4275 commit f1d1ab2

File tree

4 files changed

+22
-3
lines changed

4 files changed

+22
-3
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,31 @@ To reproduce the setup:
1515
- Create an organization, get your **Record Key** and **Project Id** at https://app.currents.dev
1616
- Set [GitHub secret variable](https://docs.github.com/en/actions/reference/encrypted-secrets) `CURRENTS_RECORD_KEY`.
1717

18+
## Examples
19+
1820
See the example GH Actions configuration:
1921

20-
- [test-basic-pwc.yml](.github/workflows/test-basic-pwc.yml)
21-
- [test-basic-reporter.yml](.github/workflows/test-basic-reporter.yml)
22+
### Parallel Playwright Tests using Playwright Shards and GitHub Actions Matrix
23+
24+
- Parallel run using 3 shards and `pwc` command - [test-basic-pwc.yml](.github/workflows/test-basic-pwc.yml)
25+
26+
<small>Basic example of running playwright tests in parallel using 3 containers of GitHub Actions Matrix and `pwc` command.</small>
27+
28+
- Parallel run using 3 shards and `playwright.config.ts` configuration - [test-basic-reporter.yml](.github/workflows/test-basic-reporter.yml)
29+
30+
<small>Basic example of running playwright tests in parallel using 3 containers of GitHub Actions Matrix configuring Currents Reporter in `playwright.config.ts`</small>
31+
32+
### Parallel Playwright Tests using Currents Orchestration and GitHub Actions Matrix
33+
34+
- Parallel run using 5 shards and [Currents Orchestration for Playwright](https://docs.currents.dev/guides/parallelization-guide/pw-parallelization/playwright-orchestration) - [test-or8n.yml](.github/workflows/test-or8n.yml)
35+
36+
<small> Currents Orchestration speeds up CI runs by up to 40% (compared to native sharding) by optimally balancing tests between the available machines</small>
37+
38+
### Misc
39+
40+
- Parallel run using Argos CI and Currents orchestration - [argos-example.yml](.github/workflows/argos-example.yml)
2241

23-
Additional resources:
42+
## Additional resources
2443

2544
- Playwright Features on Currents: https://currents.dev/playwright
2645
- Integration Documentation: https://currents.dev/readme/integration-with-playwright/currents-playwright

0 commit comments

Comments
 (0)