Using GitHub Actions with cypress-io/github-action

If you’re already using the Cypress’s @cypress-io/github-action, modify the step like this:

yaml
- 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:

yaml
- 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.

Recording and Uploading your CI replays

Using Github Actions without cypress-io/github-action

Helpful?