GitHub Actions Test Logger

To produce a test summary file instead of just logging to the console, set the GITHUB_STEP_SUMMARY environment variable to your desired output file path before running the tests.

$env:GITHUB_STEP_SUMMARY="./test-summary.md"

When using Microsoft.Testing.Platform, the reporter is automatically detected and registered when running in a GitHub Actions environment. You can also enable it manually using the --report-github option.

Important Compatibility Notes

• xUnit v3: Replace the xunit.v3 package reference with xunit.v3.mtp-v2. The standard xunit.v3 uses MTP v1, which is incompatible.
• Peer Dependency: It is highly recommended to install the latest version of Microsoft.Testing.Platform in your test project.
• Package Visibility: Do not mark the GitHubActionsTestLogger package reference as private (e.g., do not use PrivateAssets="all"), as it must be included in the build output.

run: dotnet test --configuration Release --report-github

Install the package via NuGet to enable test reporting to GitHub Actions for your test projects.

dotnet add package GitHubActionsTestLogger

To produce a test summary that can be used in a GitHub Actions workflow, set the GITHUB_STEP_SUMMARY environment variable to the desired output file path before running your tests. This tells the logger where to write the markdown summary.

$env:GITHUB_STEP_SUMMARY="./test-summary.md"

By default, VSTest does not collect source information, so the extension relies on stack traces to extract it for failed tests. To improve accuracy, instruct the runner to collect source information by adding RunConfiguration.CollectSourceInformation=true as an argument after a double dash (--).

Alternatively, you can enable this in a .runsettings file.

run: >
  dotnet test
  --configuration Release
  --logger GitHubActions
  -- 
  RunConfiguration.CollectSourceInformation=true

To run the demo tests using Microsoft.Testing.Platform and generate GitHub Actions test reports, use the dotnet test command with the -p:IsTestProject=true property and the --report-github flag.

$ dotnet test -p:IsTestProject=true --report-github

When using VSTest, customize the reporter by adding options to the --logger string, delimited by semicolons.

run: dotnet test --configuration Release --logger "GitHubActions;annotations-title=@test;annotations-message=@error"

When using Microsoft.Testing.Platform, customize the reporter by passing arguments prefixed with --report-github-.

run: >
  dotnet test
  --configuration Release
  --report-github
  --report-github-annotations-title @test
  --report-github-annotations-message @error

To run the demo tests using the VSTest engine, use the dotnet test command with the GitHubActions logger specified via the --logger flag. The -p:IsTestProject=true property is used to identify the test project in this specific demo setup.

$ dotnet test -p:IsTestProject=true --logger GitHubActions

Use these tokens to format annotations-title and annotations-message:

• @test: The display name of the test.
• @error: The error message.
• @trace: The stack trace.
• @framework: The target framework.

The following options are available to customize the reporter behavior. The syntax differs by runner: