Jest Reporter for GitHub Actions

A custom reporter for Jest that creates annotations when run via GitHub Actions

Installation

npm install -D @jamesacarr/jest-reporter-github-actions

Or, even better:

yarn add -D @jamesacarr/jest-reporter-github-actions

Usage

To get annotations working in your GitHub Actions runs, you need to setup Jest to use this reporter. You can do that by adding the following to your jest.config.js:

module.exports = {
  reporters: [
    'default',
    '@jamesacarr/jest-reporter-github-actions'
  ],
  testLocationInResults: true,
}

Or, you can simply run Jest with the following options:

jest --testLocationInResults --reporters=default --reporters=@jamesacarr/jest-reporter-github-actions