root
/
playwright
mirror of https://github.com/microsoft/playwright.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: note about sharded projects in the merged config (#30184) 

Fixes https://github.com/microsoft/playwright/issues/29841
This commit is contained in:
Yury Semikhatsky 2024-04-02 14:41:23 -07:00 committed by GitHub
parent 8056e5391f
commit 39b3c93b85
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/src/test-reporter-api/class-reporter.md
View File

@ -87,6 +87,15 @@ and [`method: Reporter.onError`] is called when something went wrong outside of
If your custom reporter does not print anything to the terminal, implement [`method: Reporter.printsToStdio`] and return `false`. This way, Playwright will use one of the standard terminal reporters in addition to your custom reporter to enhance user experience. If your custom reporter does not print anything to the terminal, implement [`method: Reporter.printsToStdio`] and return `false`. This way, Playwright will use one of the standard terminal reporters in addition to your custom reporter to enhance user experience.
**Merged report API notes**
When merging mutliple [`blob`](./test-reporters#blob-reporter) reports via [`merge-reports`](./test-sharding#merge-reports-cli) CLI
command, the same [Reporter] API is called to produce final reports and all existing reporters
should work without any changes. There some subtle differences though which might affect some custom
reporters.
* Projects from different shards are always kept as separate [TestProject] objects. E.g. if project 'Desktop Chrome' was sharded across 5 machines then there will be 5 instances of projects with the same name in the config passed to [`method: Reporter.onBegin`].
## optional method: Reporter.onBegin ## optional method: Reporter.onBegin
* since: v1.10 * since: v1.10

11
packages/playwright/types/testReporter.d.ts vendored
View File

@ -441,6 +441,17 @@ export interface FullResult {
* [reporter.printsToStdio()](https://playwright.dev/docs/api/class-reporter#reporter-prints-to-stdio) and return * [reporter.printsToStdio()](https://playwright.dev/docs/api/class-reporter#reporter-prints-to-stdio) and return
* `false`. This way, Playwright will use one of the standard terminal reporters in addition to your custom reporter * `false`. This way, Playwright will use one of the standard terminal reporters in addition to your custom reporter
* to enhance user experience. * to enhance user experience.
*
* **Merged report API notes**
*
* When merging mutliple [`blob`](https://playwright.dev/docs/api/test-reporters#blob-reporter) reports via
* [`merge-reports`](https://playwright.dev/docs/api/test-sharding#merge-reports-cli) CLI command, the same {@link Reporter} API is called to
* produce final reports and all existing reporters should work without any changes. There some subtle differences
* though which might affect some custom reporters.
* - Projects from different shards are always kept as separate {@link TestProject} objects. E.g. if project
* 'Desktop Chrome' was sharded across 5 machines then there will be 5 instances of projects with the same name in
* the config passed to
* [reporter.onBegin(config, suite)](https://playwright.dev/docs/api/class-reporter#reporter-on-begin).
*/ */
export interface Reporter { export interface Reporter {
/** /**