Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove mentions of npx @replayio/cypress run #202

Merged
merged 4 commits into from
Jun 13, 2024
Merged

Remove mentions of npx @replayio/cypress run #202

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9f6afa
Remove mentions of `npx @replayio/cypress run`
Andarist Jun 12, 2024
fe11252
remove recording strategies
Andarist Jun 12, 2024
47fd232
extend failed links summary with source
Andarist Jun 13, 2024
d4df8b5
update `vercel.json`
Andarist Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/app/basics/test-suites/overview/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ At the first glance, that recording may look like a series of snapshots of your

{% accordion-item title="When do I use Replay with my tests?" %}

There are a [couple of strategies](/reference/ci-workflows/recording-strategies) you can adopt, but generally you can use Replay Browser with every test run on your CI, as there is both short-term and long-term value.
There are a couple of strategies you can adopt, but generally you can use Replay Browser with every test run on your CI, as there is both short-term and long-term value.

When a test fails on CI, you don’t need to replicate it locally anymore. A replay captures your test run **exactly** as it happened and will provide you better insight than if you tried to locally reproduce an issue from CI.

Expand Down
34 changes: 3 additions & 31 deletions src/app/reference/ci-workflows/recording-strategies/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,14 @@ title: Recording strategies
description: Depending on what problem you’re trying to solve, there are two primary ways of using Replay.
---

## Record failures on PRs
## Record on PRs

This is useful for debugging failing tests in pull requests. It only records failing tests so there’s minimal overhead, and those replays will be available for debugging immediately after tests finish.

Run your tests and pass the mode `record-on-retry` .

{% tabs labels=["npm", "yarn", "pnpm"] %}
{% tab %}

```sh
npx @replayio/cypress run --mode record-on-retry
```

{% /tab %}
{% tab %}

```sh
yarn @replayio/cypress run --mode record-on-retry
```

{% /tab %}
{% tab %}

```sh
pnpx @replayio/cypress run --mode record-on-retry
```

{% /tab %}
{% /tabs %}
This is useful for debugging failing tests in pull requests. It records tests and those replays will be available for debugging immediately after tests finish.
Copy link
Contributor

@bvaughn bvaughn Jun 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't figure out how to actually view this content. When I try to open this page by URL or search, I get redirected to reference/ci-workflows/upload-strategies– presumably bc of the vercel.json entry– but that page doesn't have the content here. So is this content even viewable at all?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started to edit this but then figured out that it doesn't even make that much sense (IMHO) to discuss recording strategies. Sure, recording has some overhead but it should be negligible for most users. I don't think people have to be aware of this being configurable anyhow (and it actually isn't in certain scenarios, like with @replayio/playwright).

So then I went to remove references to this and forgot to remove this .md file. I'll remove it in a sec. Please let me know if my reasoning about removing it makes sense to u


## Record all on merge to master

This is useful for busting flakes. It only records failing tests so there’s minimal overhead, and those replays will be available for debugging immediately after tests finish.

Run your tests as usual, but set the trigger to only run on merge to master.

{% callout type="link" title="Upload strategies" href="/reference/ci-workflows/upload-strategies" %}
You have the flexibility to choose not only when to record but also when to upload your recordings. For details on various uploading strategies, [see the documentation](/reference/ci-workflows/upload-strategies).
You have the flexibility to choose when to upload your recordings. For details on various uploading strategies, [see the documentation](/reference/ci-workflows/upload-strategies).
{% /callout %}
4 changes: 2 additions & 2 deletions src/app/reference/test-runners/cypress-io/github-actions/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ Add a new step to run after your Cypress tests for uploading the replays:
api-key: ${{ secrets.REPLAY_API_KEY }}
```

{% callout title="Recording strategies" %}
There are different strategies for creating your replays. For example you can use Replay only when retrying a failed test, or choose to upload recordings from failed tests only. See [docs on recording strategies](/reference/ci-workflows/recording-strategies) to learn more.
{% callout title="Upload strategies" %}
There are different strategies for uploading your replays. For example you can use Replay only when retrying a failed test, or choose to upload recordings from failed tests only. See [docs on upload strategies](/reference/ci-workflows/upload-strategies) to learn more.
{% /callout %}
7 changes: 0 additions & 7 deletions src/app/reference/test-runners/cypress-io/overview/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@ npx cypress run --browser replay-chromium
description="Learn how to get started with Cypress and Replay"
/%}

{% quick-link
title="Recording options"
icon="record"
href="/reference/test-runners/cypress-io/recording-options"
description="See what recording options are available for Cypress.io and Replay"
/%}

{% quick-link
title="GitHub Actions"
icon="github"
Expand Down
154 changes: 0 additions & 154 deletions src/app/reference/test-runners/cypress-io/recording-options/page.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions src/lib/navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,6 @@ export const navigation: Record<NavigationNames, NavigationItem[]> = {
title: 'Debugging tests',
href: '/reference/test-runners/cypress-io/debugging-tests',
},
{
title: 'Recording options',
href: '/reference/test-runners/cypress-io/recording-options',
},
{
title: 'GitHub actions',
href: '/reference/test-runners/cypress-io/github-actions',
Expand Down Expand Up @@ -309,10 +305,6 @@ export const navigation: Record<NavigationNames, NavigationItem[]> = {
title: 'Generate API key',
href: '/reference/ci-workflows/generate-api-key',
},
{
title: 'Recording strategies',
href: '/reference/ci-workflows/recording-strategies',
},
{
title: 'Upload strategies',
href: '/reference/ci-workflows/upload-strategies',
Expand Down
14 changes: 11 additions & 3 deletions vercel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@
},
{
"source": "/test-suites/_archive/ci-integration/circle-ci",
"destination": "/reference/ci-workflows/recording-strategies"
"destination": "/reference/ci-workflows/upload-strategies"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these redirects blocking the recording-strategies content?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I think describing recording strategies raises the complexity here and we might not actually need this (see here). Since this content did exist, I had to redirect it somewhere and /upload-strategies seemed like a good fit

},
{
"source": "/test-suites/_archive/ci-integration/github-actions",
Expand Down Expand Up @@ -895,7 +895,11 @@
},
{
"source": "/ci-workflows/recording-strategies",
"destination": "/reference/ci-workflows/recording-strategies"
"destination": "/reference/ci-workflows/upload-strategies"
},
{
"source": "/reference/ci-workflows/recording-strategies",
"destination": "/reference/ci-workflows/upload-strategies"
},
{
"source": "/ci-workflows/upload-strategies",
Expand Down Expand Up @@ -991,7 +995,11 @@
},
{
"source": "/test-runners/cypress-io/recording-options",
"destination": "/reference/test-runners/cypress-io/recording-options"
"destination": "/reference/test-runners/cypress-io"
},
{
"source": "/reference/test-runners/cypress-io/recording-options",
"destination": "/reference/test-runners/cypress-io"
},
{
"source": "/test-runners/cypress-io/troubleshooting-guide",
Expand Down
Loading