Skip to content

Commit

Permalink
slack docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyrohrbough committed Sep 24, 2024
1 parent 06b86c3 commit e81fcef
Showing 1 changed file with 55 additions and 38 deletions.
93 changes: 55 additions & 38 deletions docs/guides/cloud/integrations/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ sidebar_position: 40
sidebar_label: Slack
---

One of our most-requested Cypress Cloud features to date, the Cypress app for Slack provides real-time results for your Cypress tests, all in one place—improving remote collaboration and giving wider visibility into test behavior and Application Quality.
One of our most-requested Cypress Cloud features, the Cypress app for Slack provides real-time results for your Cypress tests, all in one place—improving remote collaboration and giving wider visibility into test behavior and Application Quality.

The Cypress app for Slack allows you to:
- Improve cross-team collaboration by instantly surfacing Cypress results to the teams that need visibility
- Confirm that key tests pass prior to launching new products or features
- Reduce the time it takes to catch failed tests

<DocsVideo src="https://youtu.be/hnDPz7dognY?si=IuLXxcHjJOmVq376" title="Cypress app for Slack" />
<DocsVideo src="https://www.youtube.com/embed/hnDPz7dognY?si=PRRy4f5n6f1jzfVJ" title="Cypress app for Slack" />

## Getting started
You need just three things to get started:

- Cypress Cloud account
- Ability to configure Cypress Cloud integrations - You must be an admin or owner of your Cypress Cloud organization .
- Ability to authorize Slack apps - By default, Slack allows any workspace member to authorize apps, however workspace owners may require app approvals before installation. See this [Slack help article](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace) for more details.
- Ability to configure Cypress Cloud integrations - you must be an admin or the owner of your Cypress Cloud organization.
- Ability to authorize Slack apps - by default, Slack allows any workspace member to authorize apps, however workspace owners may require app approvals before installation. See this [Slack help article](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace) for more details.

### Install the Cypress app for Slack
## Install the Cypress app for Slack

1. In the Cypress Cloud, visit the Integrations page for the organization you wish to integrate with Slack.
2. Click the **Enable** button in the Slack section.
Expand All @@ -34,30 +34,52 @@ Now Cypress will post run results for all projects in your organization to the s

## Slack configuration

The Slack messages can be tailor to match your teams' needs.
The Slack messages can be tailored to match your teams' needs.

- The Slack app can send results to one or more public or private Slack channels or directly to a specific user
- You can select your notification preferences that should be posted.
- The app can be configured at the orginazation-level, as well as at the project-level, to support organizations with multiple teams working on separate projects.
- You can select your notification preferences for when and where run results should be posted.
- The app can be configured at the organization-level and project-level which supports multiple teams working on separate projects.

### Per-Organization vs per-project configuration

The following describes where to go to configure Slack for an organization and a project. The remaining sections will describe the supported configuration options.

#### Organization settings
To share Slack configuration for an organization:
1. Navigate to the Integrations page for the organization you wish to configure.
2. Within the Slack integration, click Configure.
3. Configure the app.

#### Project settings
To share Slack configuration for a project:
1. Navigate to the Project Settings page for the project you wish to configure.
2. Click on the Integrations tab within the Project Settings page.
3. Configure the app with the Slack Integration section.

### Slack channels

You can have Cypress Cloud post run results to specific channels. To add a
channel:

....global vs private configuration
1. Navigate to the Slack configuration page
2. Click **Add Slack Channel**.
3. You'll see a popup window that allows you to choose the channel or individual associate
with the organization.
4. Search for and selecting the channel messages should post to.

1. Navigate to the **Integrations** page for the organization with the installed
integration.
2. Within the Slack integration, click **Configure**.
3. Click **Add Slack Channel**.
4. You'll see a popup window that allows you to choose the channel to associate
with the organization. Cypress Cloud will post run results for all projects
in your organization to the new Slack channel.
Cypress Cloud will begin to post run results to the channel.

### Direct messages

You can have Cypress Cloud post run results to specific user. To post to a user:

### Direct Messages
1. Navigate to the Slack configuration page
2. Click **Add Slack Channel**.
3. You'll see a popup window that allows you to choose the channel or individual associate
with the organization.
4. Search for and selecting the user that messages should be sent to.

....
Cypress Cloud will begin to send run results to the this user.

### Notification preferences

Expand All @@ -68,29 +90,29 @@ only for failing runs. However, you can select any combination of the followings
- **Passed runs**: will notify on runs with a passed status.
- **Flaky tests**: will notify on runs that have an identified flaky test.

1. Navigate to Slack configuration page
2. Select the notification preferences for each channel

#### Filter notifications by tag

When configuring at the project-level, you can filter notifications posted to Slack based on a
[tag](/guides/guides/command-line#cypress-run-tag-lt-tag-gt) the run was
recorded with. This can be helpful to only post notifications on certain runs,
like those to a staging or release environment.

1. Navigate to the **Slack Integration** section in the Integrations tab of your Project's Settings.
3. Under **Tags**, select the **Tag** dropdown for the desired integration and
1. Navigate to the Slack configuration page
2. Under **Tags**, select the **Tag** dropdown for the desired integration and
select which tag to filter.


### Mute a channel

If you want Cypress Cloud to temporarily stop posting Slack messages to a
certain channel, you can **Mute** that channel. This allows you to easily pause
and resume notifications for a specific channel without losing the configuration
you've put in place.

1. Navigate to the **Integrations** page for the organization with the installed
integration.
2. Within the Cypress integration for Slack, click **Configure**.
3. Under **Actions**, select your **Mute** for each Slack channel you want
1. Navigate to the Slack configuration page
2. Under **Actions**, select your **Mute** for each Slack channel you want
muted.

### Remove a Slack channel
Expand All @@ -99,16 +121,14 @@ You can have Cypress Cloud stop posting notifications to a channel. You can
remove all Slack channels if you'd prefer to disable global notifications
altogether in favor of per-project notifications.

1. Navigate to the **Integrations** page for the organization with the installed
integration.
2. Within the Cypress integration for Slack, click **Configure**.
3. Under **Actions**, select your **Delete** for each Slack channel you want
1. Navigate to the Slack configuration page
2. Under **Actions**, select your **Delete** for each Slack channel you want
deleted.

### Remove the integration
## Remove the integration

You can completely remove the Cypress integration for Slack from your workspace.
This will remove the @cypress bot from your workspace and will delete all of the
This will remove the `@cypress` bot from your workspace and will delete all of the
Slack configurations you've set in Cypress Cloud. You cannot undo this, but you
will be able to install the Cypress integration for Slack again in the future.

Expand All @@ -118,20 +138,17 @@ will be able to install the Cypress integration for Slack again in the future.
3. Click **Uninstall Slack Integration** to uninstall the Cypress integration
for Slack.

## Security and Compliance
## Security and compliance

Review our [Privacy Policy](https://on.cypress.io/privacy-policy) for information about how the Cypress app for Slack collects and
manages your information.

### Authorizations
On behalf of users, Cypress can:
- View information about a user’s identity
- Show previews of cloud.cypress.io URLs in messages
- View URLs from cloud.cypress.io

On behalf of the app, Cypress can:
When authorized, Cypress can:
- View information about a user’s identity
- Post messages to specific channels in Slack & direct message conversations
- Show previews of cloud.cypress.io URLs in messages
- Show previews of cloud.cypress.io URLs in messages
- View URLs from cloud.cypress.io

### App scopes
Expand Down

0 comments on commit e81fcef

Please sign in to comment.