diff --git a/README.md b/README.md index 4f6e05c9..b43ca54b 100644 --- a/README.md +++ b/README.md @@ -146,3 +146,24 @@ npx vue-i18n-extract --add ![](docs/envfile_plugin_settings.png) #### Install the tailwind css Plugin from Jetbrains + +## currents.dev + +This project uses [currents.dev](https://currents.dev) to run the Cypress tests concurrently. +The following steps were taken to set it up: + +- Create a new project on currents.dev +- Add the generated `projectId` to the cypress configuration file +- Install `@currents/cli` as a dev dependency +- Add the following script to the `package.json` file: + ```json + "cypress:ci": "currents run --parallel --record --key $CURRENTS_KEY", + ``` +- Create a new Bitbucket pipelines job that exports the `CURRENTS_KEY` and runs the `cypress:ci` script +- Refactor the pipeline steps so that the dependencies are installed first and then the other steps are run in + parallel. + You can then run multiple instances of the previously created job in parallel. + See `.bitbucket-pipelines.yml` for an example. + +> 💡 The number of cypress worker jobs depends on the number of cypress tests. +> Too many workers for too few tests will result in a lot of idle workers.