action-junit-report

... reports JUnit test results as GitHub pull request check.

Quickstart 🛠️ • Showcase 🖥️ • Inputs • Outputs • Reference 📖 • License 📓

Quickstart 🛠️

1. Add the action after your test step, and let it run even when the tests failed:

- name: Publish Test Report
  id: report
  uses: mikepenz/action-junit-report@v6
  if: success() || failure() # always run even if the previous step fails
  with:
    report_paths: '**/build/test-results/test/TEST-*.xml'

2. Give the workflow permission to create the check:

permissions:
  checks: write
  pull-requests: write # only required if `comment: true` was enabled

3. Optionally read the counts back out — see Action outputs:

- run: echo "${{ steps.report.outputs.failed }} of ${{ steps.report.outputs.total }} tests failed"

[!TIP] Running from a workflow_run workflow, or from a fork? See PR run permissions.

Showcase 🖥️

The failure is annotated inline, on the line the test failed on:

...and collected on the check run, one entry per failed test case:

Reference

What's included 🚀

• Flexible JUnit parser with wide support
• Supports both <failure> and <error> test case results
• Supports nested test suites
• Blazingly fast execution
• Lighweight
• Rich build log output

This action processes JUnit XML test reports on pull requests and shows the result as a PR check with summary and annotations.

Based on action for Surefire Reports by ScaCap

Setup

Configure the workflow

name: build
on:
  pull_request:

jobs:
  build:
    name: Build and Run Tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
      - name: Build and Run Tests
        run: # execute your tests generating test results
      - name: Publish Test Report
        uses: mikepenz/action-junit-report@v6
        if: success() || failure() # always run even if the previous step fails
        with:
          report_paths: '**/build/test-results/test/TEST-*.xml'

Inputs

Common Configurations

If you observe out-of-memory errors, follow the below configuration suggestion.

[!TIP] FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory

- name: Publish Test Report
  uses: mikepenz/action-junit-report@v6
  env:
    NODE_OPTIONS: "--max-old-space-size=4096"
  if: success() || failure() # always run even if the previous step fails
  with:
    report_paths: '**/build/test-results/test/TEST-*.xml'

Action outputs

After action execution it will return the test counts as output.

# ${{steps.{CHANGELOG_STEP_ID}.outputs.total}}

A full set list of possible output values for this action.

PR run permissions

The action requires write permission on the checks. If the GA token is read-only (this is a repository configuration) please enable write permission via:

permissions:
  checks: write
  pull-requests: write # only required if `comment: true` was enabled

Additionally for security reasons, the github token used for pull_request workflows is marked as read-only. If you want to post checks to a PR from an external repository, you will need to use a separate workflow which has a read/write token, or use a PAT with elevated permissions.

name: build
on:
  pull_request:

jobs:
  build:
    name: Build and Run Tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3
      - name: Build and Run Tests
        run: # execute your tests generating test results
      - name: Upload Test Report
        uses: actions/upload-artifact@v3
        if: always() # always run even if the previous step fails
        with:
          name: junit-test-results
          path: '**/build/test-results/test/TEST-*.xml'
          retention-days: 1

---
name: report
on:
  workflow_run:
    workflows: [ build ]
    types: [ completed ]

permissions:
  checks: write

jobs:
  checks:
    runs-on: ubuntu-latest
    steps:
      - name: Download Test Report
        uses: dawidd6/action-download-artifact@v2
        with:
          name: junit-test-results
          workflow: ${{ github.event.workflow.id }}
          run_id: ${{ github.event.workflow_run.id }}
      - name: Publish Test Report
        uses: mikepenz/action-junit-report@v6
        with:
          commit: ${{github.event.workflow_run.head_sha}}
          report_paths: '**/build/test-results/test/TEST-*.xml'
          # Optional: if you want to add PR comments from workflow_run context  
          # comment: true
          # pr_id: ${{ github.event.workflow_run.pull_requests[0].number }}

In environments that do not allow checks: write, the action can be configured to leverage the annotate_only option.

name: pr

on:
  pull_request:

jobs:
  unit_test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Build and Run Tests
        run: # execute your tests generating test results

      - name: Write out Unit Test report annotation for forked repo
        if: ${{ failure() &&  (github.event.pull_request.head.repo.full_name != github.repository) }}
        uses: mikepenz/action-junit-report@v6
        with:
          annotate_only: true # forked repo cannot write to checks so just do annotations

# Install the dependencies  
$ npm install

# Verify lint is happy
$ npm run lint -- --fix

# Format
$ npm run format

# Build the typescript and package it for distribution
$ npm run build && npm run package

# Run the tests, use to debug, and test it out
$ npm test

Credits

Original idea and GitHub Actions by: https://github.com/ScaCap/action-surefire-report

Other actions

• release-changelog-builder-action
• xray-action
• jira-release-composition-action

License

Copyright (C) 2025 Mike Penz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.