diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bed5ba --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Currents + Jest on GitHub Actions Example + +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. + +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 ...`