feat(reporter): Add github action reporter.

docs/src/test-advanced-js.md

@@ -38,7 +38,7 @@ These options would be typically different between local development and CI oper
   - `'failures-only'` - only preserve output for failed tests.
 - `projects: Project[]` - Multiple [projects](#projects) configuration.
 - `quiet: boolean` - Whether to suppress stdout and stderr from the tests.
-- `reporter: 'list' | 'line' | 'dot' | 'json' | 'junit'` - The reporter to use. See [reporters](./test-reporters.md) for details.
+- `reporter: 'list' | 'line' | 'dot' | 'json' | 'junit' | 'github'` - The reporter to use. See [reporters](./test-reporters.md) for details.
 - `reportSlowTests: { max: number, threshold: number } | null` - Whether to report slow tests. When `null`, slow tests are not reported. Otherwise, tests that took more than `threshold` milliseconds are reported as slow, but no more than `max` number of them. Passing zero as `max` reports all slow tests that exceed the threshold.
 - `shard: { total: number, current: number } | null` - [Shard](./test-parallel.md#shard-tests-between-multiple-machines) information.
 - `updateSnapshots: boolean` - Whether to update expected snapshots with the actual results produced by the test run.

docs/src/test-reporters-js.md

@@ -98,6 +98,34 @@ const config: PlaywrightTestConfig = {
 export default config;
 ```
 
+### Reporter for GitHub Actions
+
+You can use the built in `github` reporter to get automatic failure annotations when running in GitHub actions.
+
+```js js-flavor=js
+// playwright.config.js
+// @ts-check
+
+/** @type {import('@playwright/test').PlaywrightTestConfig} */
+const config = {
+  // 'github' for GitHub Actions CI to generate annotations, default 'list' when running locally
+  reporter: process.env.CI ? 'github' : 'list',
+};
+
+module.exports = config;
+```
+
+```js js-flavor=ts
+// playwright.config.ts
+import { PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  // 'github' for GitHub Actions CI to generate annotations, default 'list' when running locally
+  reporter: process.env.CI ? 'github' : 'list',
+};
+export default config;
+```
+
 ## Built-in reporters
 
 All built-in reporters show detailed information about failures, and mostly differ in verbosity for successful runs.

package.json

@@ -91,6 +91,7 @@
     "@types/extract-zip": "^1.6.2",
     "@types/mime": "^2.0.3",
     "@types/minimatch": "^3.0.3",
+    "@types/ms": "^0.7.31",
     "@types/node": "^14.17.15",
     "@types/pixelmatch": "^5.2.1",
     "@types/pngjs": "^3.4.2",
@@ -136,4 +137,4 @@
     "xml2js": "^0.4.23",
     "yaml": "^1.10.0"
   }
-}
+}