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

Report Jest test results to Currents - a cloud platform for debugging, troubleshooting and analysing CI tests
https://github.com/currents-dev/currents-jest-github-actions-example

cicd currents jest jest-reporter jest-shards test-automation

Last synced: 21 days ago
JSON representation

Report Jest test results to Currents - a cloud platform for debugging, troubleshooting and analysing CI tests

• Host: GitHub
• URL: https://github.com/currents-dev/currents-jest-github-actions-example
• Owner: currents-dev
• Created: 2024-07-16T22:02:53.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-16T22:17:16.000Z (5 months ago)
• Last Synced: 2024-11-30T14:45:16.648Z (26 days ago)
• Topics: cicd, currents, jest, jest-reporter, jest-shards, test-automation
• Language: JavaScript
• Homepage: https://currents.dev
• Size: 75.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Currents + Jest on GitHub Actions Example

## About

This repository demonstrates how to report test results generated by Jest to [Currents](https://currents.dev) - a cloud platform for debugging, troubleshooting and analysing CI tests.

This example runs Jest tests in [parallel](https://jestjs.io/docs/cli#--shard) using GitHub actions matrix with 2 containers.

## How to reproduce

Follow the steps to reproduce this example:

- Create an account at https://app.currents.dev and obtain Project Id and Record Key

- Save the Record Key as [Repository Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) `CURRENTS_RECORD_KEY`

- Add `@currents/cmd` and `@currents/jest` as a dependency

- Add `@currents/jest` as Jest reporter (see `./jest.config.js`)

- Configure GitHub actions [workflow](.github/workflows/test.yml):

  - run the tests: `npm run test`

  - upload the test results to Currents: `npx currents upload ...`

## Resources

- 📖 [Currents documentation](https://docs.currents.dev)

- [`@currents/cmd`](https://docs.currents.dev/resources/reporters/currents-cmd)

- [`@currents/jest`](https://docs.currents.dev/resources/reporters/currents-jest)