replayio / action-upload

GitHub Action to upload recordings to Replay.io

replayio/action-upload

Upload recordings to Replay

Use with @replayio/cypress or @replayio/playwright to record and upload replays of failed tests. Read more in the Replay documentation here.

Usage

1. Log into app.replay.io
2. Create a Team API key (Personal API keys can be used, but have a limit of 10 recordings)
3. Store the API key as a GitHub Repository Secret named RECORD_REPLAY_API_KEY
4. Add the configuration below to your existing workflow

- uses: replayio/action-upload@v0.5.1
  with:
    api-key: ${{ secrets.RECORD_REPLAY_API_KEY }}

If no filter is passed, all replays, passed and failing, will be uploaded. To upload only failed tests, use the following example:

- uses: replayio/action-upload@v0.5.1
  with:
    api-key: ${{ secrets.RECORD_REPLAY_API_KEY }}
    filter: ${{ 'function($v) { $v.metadata.test.result = "failed" }' }}

Arguments

Required	Name	Description	Default
✅	api-key	The Replay API Key used to upload recordings
	filter	A JSONata function to pass to [$filter](https://docs.jsonata.org/higher-order-functions#filter) to select replays to upload
	public	When true, make replays public on upload	false
	include-summaries	When true, a table of uploaded replays is added to the GitHub workflow summary page	true

Returns

Name	Description
recordings	An array of recording IDs uploaded