{"id":17275142,"url":"https://github.com/daun/playwright-report-summary","last_synced_at":"2025-08-16T08:19:33.983Z","repository":{"id":193337815,"uuid":"688555811","full_name":"daun/playwright-report-summary","owner":"daun","description":"A GitHub action to report Playwright test results as pull request comments","archived":false,"fork":false,"pushed_at":"2025-08-01T11:38:10.000Z","size":1449,"stargazers_count":65,"open_issues_count":2,"forks_count":14,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-01T13:44:18.594Z","etag":null,"topics":["comments","github-actions","job-summary","playwright","pull-requests","test-results"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daun.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-07T15:35:40.000Z","updated_at":"2025-08-01T11:38:08.000Z","dependencies_parsed_at":"2023-09-09T18:12:41.494Z","dependency_job_id":"b724a6ab-9335-4e34-b699-7851df97bc3d","html_url":"https://github.com/daun/playwright-report-summary","commit_stats":null,"previous_names":["daun/playwright-report-comment","daun/playwright-report-summary"],"tags_count":24,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/daun/playwright-report-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daun%2Fplaywright-report-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daun%2Fplaywright-report-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daun%2Fplaywright-report-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daun%2Fplaywright-report-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daun","download_url":"https://codeload.github.com/daun/playwright-report-summary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daun%2Fplaywright-report-summary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270684545,"owners_count":24627822,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comments","github-actions","job-summary","playwright","pull-requests","test-results"],"created_at":"2024-10-15T08:55:31.394Z","updated_at":"2025-08-16T08:19:33.973Z","avatar_url":"https://github.com/daun.png","language":"TypeScript","readme":"# ![report](https://icongr.am/octicons/comment-discussion.svg?size=22\u0026color=abb4bf)   Playwright Report Summary\n\n[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)\n![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)\n\nA GitHub action to report Playwright test results as a pull request comment.\n\n- Parse the JSON test report generated by Playwright\n- Generate a markdown summary of the test results\n- Post the summary as a pull request comment\n- Uses GitHub's official [icons](https://primer.style/design/foundations/icons) and [color scheme](https://primer.style/design/foundations/color)\n\n## Examples\n\n\u003cimg src=\"assets/comment-passed.png\" width=\"701\"\u003e\n\n\u003cimg src=\"assets/comment-failed.png\" width=\"701\"\u003e\n\n## Usage\n\n### Basic usage\n\nPlaywright must be configured to [generate a JSON report](https://playwright.dev/docs/test-reporters#json-reporter)\nand write it to disk. This action receives the report file path as input, in this case `results.json`.\n\nNote the `if: always()` to ensure the report comment is created even if the tests failed.\n\n```yaml\njobs:\n  test:\n    name: Run playwright tests\n    needs: install\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v3\n        with:\n          node-version: 20\n\n      - run: PLAYWRIGHT_JSON_OUTPUT_NAME=results.json npx playwright test --reporter=json\n\n      - uses: daun/playwright-report-summary@v3\n        if: always()\n        with:\n          report-file: results.json\n```\n\n### Usage with custom commenting logic\n\nThe action will do the work of creating comments and updating them whenever tests re-run. If you\nrequire custom logic for creating and updating comments, you can disable the default logic and use\nany other action in combination with the `summary` output of this action.\n\nA few recommended actions are\n[Sticky Pull Request Comment](https://github.com/marketplace/actions/sticky-pull-request-comment)\nand [Create or Update Comment](https://github.com/marketplace/actions/create-or-update-comment).\n\n```diff\n  - uses: daun/playwright-report-summary@v3\n    if: always()\n    id: summary\n    with:\n      report-file: results.json\n+     create-comment: false\n\n+ - uses: marocchino/sticky-pull-request-comment@v2\n+   with:\n+     message: ${{ steps.summary.outputs.summary }}\n```\n\n## Options\n\n```yaml\n- uses: daun/playwright-report-summary@v3\n  if: always()\n  with:\n    # The GitHub access token to use for API requests\n    # Defaults to the standard GITHUB_TOKEN\n    github-token: ''\n\n    # Path to the JSON report file generated by Playwright. Required.\n    report-file: 'results.json'\n\n    # A unique tag to represent this report when reporting on multiple test runs\n    # Defaults to the current workflow name\n    report-tag: ''\n\n    # URL to a published html report, uploaded by another action in a previous step.\n    # Example pipeline: https://playwright.dev/docs/test-sharding#publishing-report-on-the-web\n    report-url: 'https://user.github.io/repo/yyyy-mm-dd-id/'\n\n    # Number of the pull request to comment on. This is only required if the action\n    # is run outside a pull request context or needs to comment on another PR.\n    pr-number: 123\n\n    # Whether the action should create the actual comment. Set to false to implement\n    # your own commenting logic.\n    # Default: true\n    create-comment: true\n\n    # Title/headline to use for the created pull request comment.\n    # Default: 'Playwright test results'\n    comment-title: 'Test results'\n\n    # Additional information to include in the summary comment, markdown-formatted\n    # Default: ''\n    custom-info: 'For more information, [see our readme](http://link)'\n\n    # Create a job summary comment for the workflow run\n    # Default: false\n    job-summary: false\n\n    # Icon style to use: octicons | emojis\n    # Default: octicons\n    icon-style: 'octicons'\n\n    # Command used to run tests. If provided, a command to re-run failed or\n    # flaky tests will be printed for each section.\n    # Default: ''\n    test-command: 'npm run test --'\n\n    # Additional content to add to the comment below the test report.\n    # Default: ''\n    footer: ''\n```\n\n## Output\n\nThe action creates three output variables:\n\n### summary\n\nThe rendered markdown summary of the test report.\n\n### comment-id\n\nThe ID of the comment that was created or updated\n\n### report-data\n\nThe raw data of the test report, as a JSON-encoded string. This is\nuseful for creating custom summaries or debugging. You can get an idea\nof the data structure by checking out the [ReportSummary interface](https://github.com/daun/playwright-report-summary/blob/main/src/report.ts#L13).\n\n## License\n\n[MIT](./LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaun%2Fplaywright-report-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaun%2Fplaywright-report-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaun%2Fplaywright-report-summary/lists"}