From 091dbffa5b434d2f7cdcc2bdb55faefda7d9e8ac Mon Sep 17 00:00:00 2001 From: Andrew Goldis Date: Tue, 16 Jul 2024 15:16:28 -0700 Subject: [PATCH] Change readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bed5ba..59266a2 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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)