If you’re using GitHub Actions and running tests by calling a script, but aren’t using Cypress’s @cypress-io/github-action, create a similar script in package.json like this:
"scripts": { "cy:run": "cypress run", // original test script "cy:run:replay": "cypress run --browser='Replay Chromium'" // new test script }
Use that new test script instead in your current workflow file, and add the environment variable(s):
- name: Cypress run # run: npm run cy:run run: npm run cy:run:replay env: # πŸ™‹β€β™‚οΈ Add this environment variable RECORD_REPLAY_METADATA_FILE: /tmp/replay-metadata RECORD_REPLAY_DISABLE_ASSERTS: 1 RECORD_REPLAY_DISABLE_SOURCEMAP_COLLECTION: 1
Add a new step to run after this Cypress GitHub Action for uploading the replays:
- name: Upload replays if: always() uses: replayio/action-upload@v0.4.6 with: api-key: ${{ secrets.RECORD_REPLAY_API_KEY }}
Lastly, add your API key to your Secrets. To get an API key, create a new Replay team and generate an API key β€” instructions can be found here.
If you run into any problems, consult our troubleshooting guide here.