Using GitHub Actions without cypress-io/github-action

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:

json
"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):

yaml
- name: Cypress run
  #	run: npm run cy:run 
	run: npm run cy:run:replay
	env:
		REPLAY_API_KEY: ${{ secrets.RECORD_REPLAY_API_KEY }}

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