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.

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

app notification docs #5324

Merged
merged 7 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
62 changes: 61 additions & 1 deletion docs/guides/cloud/recorded-runs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -370,10 +370,70 @@ information about specific runs can be found on the

The [Debug](/guides/core-concepts/cypress-app#Debug) page allows you to easily
debug failed CI test runs from within the Cypress app. From this page, you can
review, rerun, and debug failed CI test runs that are recorded to Cypress
review, rerun, and debug faƒiled CI test runs that are recorded to Cypress
elylucas marked this conversation as resolved.
Show resolved Hide resolved
Cloud - all without leaving the Cypress app.

<DocsImage
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"
elylucas marked this conversation as resolved.
Show resolved Hide resolved
/>

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.
elylucas marked this conversation as resolved.
Show resolved Hide resolved

:::

#### 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,
elylucas marked this conversation as resolved.
Show resolved Hide resolved
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 (This typically only
elylucas marked this conversation as resolved.
Show resolved Hide resolved
happens in CI and not locally).
elylucas marked this conversation as resolved.
Show resolved Hide resolved
- 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.
11 changes: 11 additions & 0 deletions docs/guides/core-concepts/cypress-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,17 @@ 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"
elylucas marked this conversation as resolved.
Show resolved Hide resolved
/>

You can receive notifications in the Cypress app for recorded runs directly from
Cypress Cloud. Click [here](/guides/cloud/recorded-runs#Notifications) for more
info.
elylucas marked this conversation as resolved.
Show resolved Hide resolved

## Test Runner

At the core of the app is the Test Runner itself. Cypress runs tests
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.