Jest - GitHub Actions

Running Jest in Parallel on GitHub Actions using Matrix Workflow

TL;DR Check out the example repository:

https://github.com/currents-dev/currents-jest-github-actions-example

Currents uses the native Jest sharding (Jest v28+) to split the tests between multiple containers.

Here's an example workflow configuration file:

.github/workflows /jest.yml

name: Run Jest

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        shard: [1, 2]

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install dependencies
        run: npm install

      - name: Run tests in shard ${{ matrix.shard }}
        run: |
          npx jest --shard=${{ matrix.shard }}/2

      - name: Upload test results to Currents.dev
        # CURRENTS_RECORD_KEY is a secret stored in the repository settings
        env:
          CURRENTS_RECORD_KEY: ${{ secrets.CURRENTS_RECORD_KEY }}
        run: |
          npx currents upload --project-id mdXsz8 --ci-build-id ${{ github.repository }}-${{ github.run_id }}-${{ github.run_attempt }}

• Get your Record Key and set GH secret variableCURRENTS_RECORD_KEY.
• Set the Project ID

  • Option 1: Update npx currents upload --project-id argument to your project's id.
  • Option 2: Set it up in the reporter config instead.

Explore

@currents/jest

CI Build ID