README.md

Jest Reporter

Creates annotations based on the output of json (see how to configure jest properly).

Example

.github/workflows/your-workflow.yml

jobs:
  workflow-test-step:
    permissions:
      contents: read
      pull-requests: read
      checks: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: jest --json --outputFile=result.json --testLocationInResults
      - uses: tanmen/jest-reporter@v1
        if: always()
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

github-token - required

We'll need that to enrich the actions run with annotations. The secret is automatically generate by github.com.

result-file - optional

The location of the json file.

default value

./result.json

action-name - optional

The action names. Make sure this name is unique within the workflow. If it is not unique, it will be overwritten.

default value

jest report

jest Configuration

jest --json --outputFile=result.json --testLocationInResults