https://github.com/cschleiden/jest-github-actions-reporter

Jest reporter to create annotations when running tests in GitHub Actions
https://github.com/cschleiden/jest-github-actions-reporter

Last synced: about 4 hours ago
JSON representation

Jest reporter to create annotations when running tests in GitHub Actions

• Host: GitHub
• URL: https://github.com/cschleiden/jest-github-actions-reporter
• Owner: cschleiden
• License: mit
• Created: 2019-11-19T04:18:40.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-18T19:18:41.000Z (about 2 years ago)
• Last Synced: 2024-09-21T12:57:27.596Z (12 days ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/jest-github-actions-reporter
• Size: 255 KB
• Stars: 49
• Watchers: 4
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Update 2022-05-17:

With version [28](https://jestjs.io/blog/2022/04/25/jest-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](https://jestjs.io/blog/2022/04/25/jest-28#github-actions-reporter) 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. 

![](https://github.com/cschleiden/jest-github-actions-reporter/blob/master/img/annotations.png)

## 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`:

```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`:

```jsonc

{

    // ...

    "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`

```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](https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message) for more information.