Report

A Claude Code skill for report workflows and automation

What Is Report?

The "Report" skill is an automation tool designed to generate comprehensive test reports as part of a development workflow. Integrated with Claude Code, this skill streamlines the reporting process by automatically parsing test results, summarizing outcomes, and routing reports to the most relevant destination based on your environment. It is especially tailored for Playwright-based test suites but is flexible enough to fit into a variety of continuous integration and reporting pipelines. The core philosophy behind Report is to eliminate manual steps in test result analysis and sharing, seamlessly plugging into your existing tools without requiring additional installations or changes to your workflow.

Why Use Report?

Modern software projects demand rapid feedback and actionable insights from test automation. Manual report generation is error-prone, time-consuming, and often inconsistent. The Report skill addresses these challenges by automating the collection, parsing, formatting, and distribution of test results. Whether you are working in a local environment, using cloud-based CI/CD services, or collaborating with distributed teams, Report ensures that stakeholders have access to up-to-date, accurate, and well-formatted results. This enables faster debugging, more informed decision-making, and a smoother development cycle. By intelligently detecting your environment and routing reports accordingly, Report minimizes context-switching and enhances team productivity.

How to Get Started

To begin using the Report skill, ensure that your project is set up with Playwright and that your tests are written and organized according to standard practices. The skill is invoked whenever you request test results using phrases like "test report," "results summary," "test status," "show results," "test dashboard," or "how did tests go." The workflow is as follows:

  1. Check for Existing Results: The skill first inspects your workspace for recent test output under directories such as test-results/ or playwright-report/. If no results are found, it triggers a new test run with multiple reporters enabled (JSON, HTML, list).

    ls -la test-results/ playwright-report/ 2>/dev/null
    npx playwright test --reporter=json,html,list 2>&1 | tee test-output.log
  2. Parse Test Results: After execution, the skill reads the JSON report to extract metrics like the number of passed, failed, skipped, and flaky tests, along with test durations and error messages.

    npx playwright test --reporter=json 2> /dev/null
  3. Detect Report Destination: The system checks for specific environment variables or configurations to determine where to send the report. This could be TestRail, Slack, GitHub Actions, a local HTML report, or a markdown summary.

  4. Generate and Share Report: The skill produces a markdown report by default and, if applicable, routes a summary or detailed report to the detected destination.

Key Features

  • Zero New Tools Required: Integrates directly into your existing workflow without introducing additional dependencies.
  • Automatic Environment Detection: Scans for environment variables or configuration files to determine where and how to deliver your report (e.g., TestRail, Slack, GitHub Actions, HTML report).
  • Comprehensive Test Metrics: Parses Playwright JSON output to report total tests, passed/failed counts, skipped and flaky tests, individual durations, and detailed error messages.
  • Flexible Output: Produces a markdown report suitable for wikis, chat tools, or direct sharing. Also supports posting to Slack, updating TestRail, serving HTML reports, or commenting on GitHub pull requests.
  • Consistent, Professional Formatting: Generates reports in a standardized, readable format that is easy to share with both technical and non-technical stakeholders.
  • Practical Automation: Handles test execution if results are missing, ensuring you always have the latest data.

Best Practices

  • Integrate with CI/CD: Configure the Report skill as part of your CI/CD pipeline to ensure every code change is accompanied by an up-to-date, automatically generated test report.
  • Leverage Environment Variables: Set relevant environment variables like TESTRAIL_URL or SLACK_WEBHOOK_URL to automatically route reports to your preferred destinations without manual intervention.
  • Maintain Test Organization: Store test results in standardized directories (test-results/, playwright-report/) to facilitate automatic detection and parsing.
  • Regularly Review Reports: Use the markdown and HTML outputs for periodic reviews, retrospectives, or to quickly identify recurring test failures and flaky tests.
  • Use Detailed Error Summaries: Pay close attention to failed and flaky test breakdowns in the generated reports to prioritize fixes and improve test stability.

Important Notes

  • The Report skill is optimized for Playwright test frameworks with standard reporting enabled; ensure your test runner outputs JSON and HTML formats for full compatibility.
  • While environment detection covers common destinations, you may need to adjust environment variables or project structure for custom workflows.
  • Markdown reports are always generated as a fallback, ensuring you never lose access to results even if no integrations are detected.
  • For sensitive environments, review permissions and access controls when posting results to third-party services (e.g., Slack, TestRail).
  • The automation relies on parsing output files; avoid manual deletions or modifications of result directories during report generation to prevent data inconsistencies.
  • Extend or customize the skill by contributing to its open-source repository, enabling support for additional report destinations or custom formatting as needed.