wopian / jest-reporter-github-annotations

Jest Reporter GitHub Annotations

Report Jest test failures directly on pull requests with GitHub annotations

Important

Jest 28 now includes a native GitHub Actions reporter. It is recommended to switch to the official GitHub Actions reporter, but this repository and package won't go away.

Check out the Jest blog post on how to setup the official Github Actions reporter on your projects!

Install

yarn install -D @wopian/jest-reporter-github-annotations

Usage

This reporter only outputs failing test results in GitHub's annotation format, so you must include the default Jest reporter to get human readable test results in the terminal logs.

CLI (preferred)

Add it to your Jest script used by your GitHub Actions workflow in package.json:

{
  "scripts": {
    "test": "jest --reporters=default --reporters=@wopian/jest-reporter-github-annotations",
  }
}

Jest Configuration

Or add it to your Jest configuration in jest.config.js:

export default {
  reporters: [
    'default',
    '@wopian/jest-reporter-github-annotations',
  ],
}

Or package.json:

{
  "jest": {
    "reporters": [
      "default",
      "@wopian/jest-reporter-github-annotations",
    ],
  }
}