Skip to content

cschleiden/jest-github-actions-reporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Update 2022-05-17:

With version 28 Jest now includes a native GitHub Actions reporter. This repository and package won't go away, but I recommend switching over to the official reporter. The blog post has some pointers on how to set this up.

Jest Reporter for GitHub Actions

A custom Jest reporter to create annotations when run via GitHub Actions.

Usage

All you have to do to get annotations in your GitHub Actions runs is to add the reporter your Jest configuration.

  1. Install npm install -D jest-github-actions-reporter
  2. Add to your jest.config.js:
module.exports = {
  reporters: [
    "default",
    "jest-github-actions-reporter"
  ],
  testLocationInResults: true
};

alternatively you can only add it during your CI build, for example in package.json:

{
    // ...
    "scripts": {
        "citest": "CI=true jest --reporters=default --reporters=jest-github-actions-reporter"
    }
}

nothing else is required, no token sharing, no REST API calls etc.

Example

.github/workflows/CI.yaml

name: CI

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: [10.x, 12.x]

    steps:
    - uses: actions/checkout@v1
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - run: npm run build --if-present
    - run: npm citest
      env:
        CI: true

How does this work?

GitHub Actions supports a number of commands that allow you to provide rich experiences without custom REST API calls etc. See the docs for more information.

About

Jest reporter to create annotations when running tests in GitHub Actions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •