Skip to content

Commit

Permalink
Revert "app notification docs (#5324)"
Browse files Browse the repository at this point in the history
This reverts commit c6ae5bc.
  • Loading branch information
jaffrepaul committed Jun 28, 2023
1 parent c6ae5bc commit a05c4d0
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 69 deletions.
59 changes: 0 additions & 59 deletions docs/guides/cloud/recorded-runs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -394,62 +394,3 @@ Cloud - all without leaving the Cypress app.
src="/img/guides/core-concepts/cypress-app/debug-page.png"
alt="Debug"
/>

### Notifications

Cypress Cloud can notify you about recorded test runs on your branch directly in
the app through system notifications.

<DocsImage
src="/img/guides/cloud/runs/app-notification.jpg"
alt="App notification on macOS"
/>

Clicking the notification will take you to the [debug](#Debug) page in the
Cypress app.

:::info

In-app notifications are available in Cypress v12.15.0 and above and requires
macOS or Linux. Windows support is coming soon.

:::

#### Configure Notifications

To enable notifications, in the Cypress app, go to Settings, then down to Device
Settings, and click the **Enable desktop notifications** button. Your system may
then prompt you to allow notifications.

<DocsImage
src="/img/guides/cloud/runs/enable-notifications.jpg"
alt="Enable notifications"
/>

You can receive notifications for the following events:

- When a recorded run starts on your current commit in Cypress Cloud
- When a recorded run starts to fail on your current commit in Cypress Cloud
- And when a recorded run completes on your current commit in Cypress Cloud,
which you can customize the events to notify you when a run passes, fails, is
canceled or has an error.

:::note

Note: You will only receive notifications for runs that are running on the same
commit that your current branch's head is on locally.

:::

Click the **Send test notification** button to test that notifications are
working properly on your system.

#### Troubleshooting Notifications

If you are not receiving notifications, please check the following:

- That the recorded run is being recorded to Cypress Cloud.
- In your system settings, make sure that notifications are enabled for the
Cypress app.
- That your local project is currently on the git commit that the test run being
recorded is sending notifications for.
10 changes: 0 additions & 10 deletions docs/guides/core-concepts/cypress-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,16 +208,6 @@ environment setups (e.g. `docker`/`docker-compose`), you may have to pass git
information using
[custom environment variables](/guides/continuous-integration/introduction#Git-information).

### Cloud Run Notifications

<DocsImage
src="/img/guides/cloud/runs/app-notification.jpg"
alt="App notification on macOS"
/>

You can receive notifications in the Cypress app for recorded runs directly from
Cypress Cloud. Learn more about [Cloud Run Notifications](/guides/cloud/recorded-runs#Notifications).

## Test Runner

At the core of the app is the Test Runner itself. Cypress runs tests
Expand Down
Binary file removed static/img/guides/cloud/runs/app-notification.jpg
Binary file not shown.
Binary file not shown.

0 comments on commit a05c4d0

Please sign in to comment.