Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: move GHA markdown reporter to playwright-dashboard (#35448)

Yury Semikhatskydbd3b6753cb9
diff --git a/.github/workflows/merge.config.ts b/.github/workflows/merge.config.ts
index 0ef418b3b2..2f35588c26 100644
--- a/.github/workflows/merge.config.ts
+++ b/.github/workflows/merge.config.ts
@@ -1,4 +1,4 @@
export default {
testDir: '../../tests',
- reporter: [[require.resolve('../../tests/config/ghaMarkdownReporter.ts')], ['html']]
+ reporter: [[require.resolve('../../packages/playwright-dashboard/lib/ghaMarkdownReporterg')], ['html']]
};
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index f17a65797e..79e4e8d937 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1725,6 +1725,10 @@
"resolved": "packages/playwright-client",
"link": true
},
+ "node_modules/@playwright/dashboard": {
+ "resolved": "packages/playwright-dashboard",
+ "link": true
+ },
"node_modules/@playwright/experimental-ct-core": {
"resolved": "packages/playwright-ct-core",
"link": true
@@ -9043,6 +9047,17 @@
"node": ">=18"
}
},
+ "packages/playwright-dashboard": {
+ "name": "@playwright/dashboard",
+ "version": "0.0.0",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "playwright-core": "1.52.0-next"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
"packages/playwright-firefox": {
"version": "1.52.0-next",
"hasInstallScript": true,
diff --git a/packages/playwright-dashboard/package.json b/packages/playwright-dashboard/package.json
new file mode 100644
index 0000000000..0c78b33bd7
--- /dev/null
+++ b/packages/playwright-dashboard/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "@playwright/dashboard",
+ "private": true,
+ "version": "0.0.0",
+ "description": "Playwright utilities for running on GitHub",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/microsoft/playwright.git"
+ },
+ "homepage": "https://playwright.dev",
+ "engines": {
+ "node": ">=18"
+ },
+ "author": {
+ "name": "Microsoft Corporation"
+ },
+ "license": "Apache-2.0",
+ "exports": {
+ "./package.json": "./package.json"
+ },
+ "dependencies": {
+ "playwright-core": "1.52.0-next"
+ }
+}
diff --git a/tests/config/ghaMarkdownReporter.ts b/packages/playwright-dashboard/src/ghaMarkdownReporter.ts
similarity index 90%
rename from tests/config/ghaMarkdownReporter.ts
rename to packages/playwright-dashboard/src/ghaMarkdownReporter.ts
index 37ddcccd63..8c61805e2c 100644
--- a/tests/config/ghaMarkdownReporter.ts
+++ b/packages/playwright-dashboard/src/ghaMarkdownReporter.ts
@@ -19,6 +19,7 @@ import { context, getOctokit } from '@actions/github';
import * as core from '@actions/core';
import type { MetadataWithCommitInfo } from 'playwright/src/isomorphic/types';
+import type { FullConfig } from '@playwright/test';
function getGithubToken() {
const token = process.env.GITHUB_TOKEN || core.getInput('github-token');
@@ -34,9 +35,9 @@ const octokit = getOctokit(getGithubToken());
const magicComment = '<!-- Generated by Playwright markdown reporter -->';
class GHAMarkdownReporter extends MarkdownReporter {
- // declare config: FullConfig;
+ declare config: FullConfig;
- async publishReport(report: string) {
+ override async publishReport(report: string) {
core.info('Publishing report to PR.');
const { prNumber, prHref } = this.pullRequestFromMetadata();
if (!prNumber) {
@@ -55,7 +56,7 @@ class GHAMarkdownReporter extends MarkdownReporter {
issue_number: prNumber,
});
for (const comment of comments) {
- if (comment.user.login === 'github-actions[bot]' && comment.body.includes(magicComment)) {
+ if (comment.user?.login === 'github-actions[bot]' && comment.body?.includes(magicComment)) {
core.info(`Minimizing comment: ${comment.html_url}`);
await octokit.graphql(`
mutation {
@@ -89,11 +90,11 @@ class GHAMarkdownReporter extends MarkdownReporter {
private pullRequestFromMetadata() {
const metadata = this.config.metadata as MetadataWithCommitInfo;
const prHref = metadata.ci?.prHref;
- return { prNumber: parseInt(prHref?.split('/').pop(), 10), prHref };
+ return { prNumber: parseInt(prHref?.split('/').pop() ?? '', 10), prHref };
}
}
-function formatComment(lines) {
+function formatComment(lines: string[]) {
let body = lines.join('\n');
if (body.length > 65535)
body = body.substring(0, 65000) + `... ${body.length - 65000} more characters`;
diff --git a/utils/workspace.js b/utils/workspace.js
index dde042b70c..a1d964025b 100755
--- a/utils/workspace.js
+++ b/utils/workspace.js
@@ -172,6 +172,11 @@ const workspace = new Workspace(ROOT_PATH, [
path: path.join(ROOT_PATH, 'packages', 'playwright-client'),
files: LICENCE_FILES,
}),
+ new PWPackage({
+ name: '@playwright/dashboard',
+ path: path.join(ROOT_PATH, 'packages', 'playwright-dashboard'),
+ files: LICENCE_FILES,
+ }),
new PWPackage({
name: '@playwright/browser-webkit',
path: path.join(ROOT_PATH, 'packages', 'playwright-browser-webkit'),