Update Slack Docs #5932
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,228 +1,143 @@ | ||||||
| --- | ||||||
| title: Cypress App for Slack | ||||||
| sidebar_position: 40 | ||||||
| sidebar_label: Slack | ||||||
| --- | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Do we capitalize '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://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 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 | ||||||
|
|
||||||
| 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. | ||||||
| 3. A popup window will be displayed requesting permission for Cypress to access the | ||||||
| workspace. | ||||||
| 4. After you approve the app permissions, you can choose your Slack workspace and channel to | ||||||
| associate with the installation. | ||||||
| 5. The installation is complete! | ||||||
|
|
||||||
| Now Cypress will post run results for all projects in your organization to the specified Slack channel. | ||||||
|
There was a problem hiding this comment. Can you do the setup without it turning on all results for the entire org to start? Like can you enable it per project to start? Or is this step required to turn it on for an org entirely. |
||||||
|
|
||||||
| ## Slack configuration | ||||||
|
|
||||||
| 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 | ||||||
|
There was a problem hiding this comment. Is 'Slack app' right here? There was a problem hiding this comment. Slack app came from Slack's documentation: https://api.slack.com/docs/apps |
||||||
| - 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: | ||||||
|
There was a problem hiding this comment. Is 'share' the right word here? Did you mean 'update' or 'configure'?
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| 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: | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
| 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 | ||||||
|
There was a problem hiding this comment. 'individual associate', not sure what you mean here. You mean you can post to private messages? |
||||||
| with the organization. | ||||||
| 4. Search for and selecting the channel messages should post to. | ||||||
|
|
||||||
| 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: | ||||||
|
There was a problem hiding this comment.
Suggested change
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| 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. | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Cypress Cloud will begin to send run results to the this user. | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Notification preferences | ||||||
|
|
||||||
| By default, Cypress Cloud will post a Slack message to each configured channel | ||||||
| only for failing runs. However, you can select any combination of the followings preferences: | ||||||
|
|
||||||
| - **Failed runs**: will notify on runs with a failed status. | ||||||
| - **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 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 Slack configuration page | ||||||
| 2. Under **Actions**, select your **Mute** for each Slack channel you want | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| muted. | ||||||
|
|
||||||
| ### Remove a Slack channel | ||||||
|
|
||||||
| 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 Slack configuration page | ||||||
| 2. Under **Actions**, select your **Delete** for each Slack channel you want | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| deleted. | ||||||
|
|
||||||
| ## 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 | ||||||
| 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. | ||||||
|
|
||||||
|
|
@@ -231,3 +146,22 @@ will be able to install the Cypress integration for Slack again in the future. | |||||
| 2. Within the Slack Integration, click **Configure**. | ||||||
| 3. Click **Uninstall Slack Integration** to uninstall the Cypress integration | ||||||
| for Slack. | ||||||
|
|
||||||
| ## 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 | ||||||
|
|
||||||
| When authorized, Cypress can: | ||||||
|
|
||||||
| - View information about a user’s identity | ||||||
|
There was a problem hiding this comment. Can we be more specific here? This sounds really broad. Like, you can see the user's first name/last name? Or their entire profile? There was a problem hiding this comment. This is what Slack shares when reviewing the app |
||||||
| - Post messages to specific channels in Slack & direct message conversations | ||||||
| - Show previews of cloud.cypress.io URLs in messages | ||||||
| - View URLs from cloud.cypress.io | ||||||
|
There was a problem hiding this comment. What? I don't understand this. We are authorized to see what data from the user's slack here? We already have urls from our own cloud account... |
||||||
|
|
||||||
| ### App scopes | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - User token scopes: `links:read`, `links:write` | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - Bot token scopes: `chat:write`, `incoming-webhook`, `links:read`, `links:write` | ||||||
emilyrohrbough marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this agreed upon wording for this? I keep reading this as the 'Cypress App', as in the product that we have, and thinking that it's going to somehow integrate Cypress App into Slack somehow?