Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. This package extends Microsoft Testing Platform to provide a GitHub Actions reporting functionality.
Install
| Product | Versions |
|---|---|
| .NET | |
| .NET Standard |
README
Microsoft.Testing.Extensions.GitHubActionsReport
Microsoft.Testing.Extensions.GitHubActionsReport is an extension for Microsoft.Testing.Platform that emits GitHub Actions-native workflow commands so test runs on GitHub Actions produce a first-class experience.
Microsoft.Testing.Platform is open source. You can find Microsoft.Testing.Extensions.GitHubActionsReport code in the microsoft/testfx GitHub repository.
Install the package
dotnet add package Microsoft.Testing.Extensions.GitHubActionsReport
About
This package extends Microsoft.Testing.Platform with:
- Per-assembly log groups: emits
::group::/::endgroup::workflow commands so each test assembly's output is collapsed by default in the runner UI - Failure annotations: emits an
::errorworkflow command for each failing test so failures appear in the workflow Annotations tab and, when the source location can be resolved, on the pull request's "Files changed" diff gutter. Skipped tests are surfaced as title-only::warningannotations so they are visible in the Annotations tab too - Job summary: appends a markdown roll-up (totals, failures, slowest tests) to the file pointed to by
GITHUB_STEP_SUMMARY, which GitHub renders on the workflow run summary page - Slow-test notices: emits a
::noticeworkflow command for any test still running past a threshold (default 60 seconds)
The extension activates when the test run is on GitHub Actions (GITHUB_ACTIONS=true) and the --report-gh switch is passed; it no-ops otherwise. When active, each feature is enabled by default and can be toggled individually:
| Option | Description | Default |
|---|---|---|
--report-gh |
Master switch that turns the extension on (required, in addition to running on GitHub Actions) | off |
--report-gh-groups on|off |
Per-assembly log groups | on |
--report-gh-annotations on|off |
Failure and skip annotations | on |
--report-gh-step-summary on|off |
Markdown job summary | on |
--report-gh-slow-test-notices on|off |
Slow-test notices | on |
--report-gh-slow-test-threshold <duration> |
Time before a slow-test notice is emitted; accepts a bare number of seconds or a unit suffix such as 90s, 2m, 1.5h |
60s |
Related packages
- Microsoft.Testing.Extensions.AzureDevOpsReport: Azure DevOps reporting
Documentation
For comprehensive documentation, see https://aka.ms/testingplatform.
Feedback & contributing
Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the microsoft/testfx GitHub repository.
Changes from Previous Version
Adoption Assessment
A verified publisher signal is available. Assess fit from the package's supported frameworks, license and dependency graph rather than popularity alone.
Related Guides & Workflows
Learn how to evaluate, integrate, or audit this package in your .NET project.