If you’re already using the Cypress’s @cypress-io/github-action, modify the step like this:
- name: Cypress run uses: cypress-io/github-action@v5 with: # πŸ™‹β€β™‚οΈ Specify Replay Chromium browser: "Replay Chromium" env: # πŸ™‹β€β™‚οΈ Add these 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.