Skip to content

Commit

Permalink
Change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
agoldis committed Jul 16, 2024
1 parent daf4551 commit 091dbff
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# 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 repo runs Jest tests in parallel using 2 shards and GitHub actions matrix.
This example runs Jest tests in [parallel](https://jestjs.io/docs/cli#--shard) using GitHub actions matrix with 2 machines.

## How to reproduce

Follow the steps to reproduce this example:

Expand All @@ -13,3 +17,9 @@ Follow the steps to reproduce this example:
- 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)

0 comments on commit 091dbff

Please sign in to comment.