-
Notifications
You must be signed in to change notification settings - Fork 251
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
Add documentation for Slack Workspace #3005
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
155c5fa
Ensure docs include Slack App privacy policy, as per their guidelines
eleanorakh ae16df6
Document user @mentions
eleanorakh 2e5a3a9
Notify in Private channel
eleanorakh e9b5f4c
Add new state transition
eleanorakh f252700
Add workspace instructions to notify process
eleanorakh 4d7c39a
Document adding a new slack workspace
eleanorakh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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.
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 | ||||
---|---|---|---|---|---|---|
|
@@ -7,7 +7,21 @@ Configuring a Slack notification service will authorize access for your desired | |||||
|
||||||
Setting up a Notification Service requires Buildkite organization admin access. | ||||||
|
||||||
## Adding a notification service | ||||||
## Adding notification services | ||||||
There are two ways to add notification services: workspace-wide and channel-specific. We reccomend using a workspace. Using a workspace only requires a single authorization for the entire workspace, allowing you to connect channels via YAML rather than multiple notifications services. The migration to a Workspace will not impact current integration implementation. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### Adding workspace notification services | ||||||
In your [Organization's Notification Settings](https://buildkite.com/organizations/-/services), add a Slack Workspace notification service: | ||||||
|
||||||
<%= image "buildkite-add-slack-workspace.png", width: 1458/2, height: 142/2, alt: "Screenshot of the 'Add' button for adding a Slack workspace service to Buildkite" %> | ||||||
|
||||||
Click the **Add to Slack** button: | ||||||
|
||||||
<%= image "buildkite-add-to-slack-workspace.png", width: 1458/2, height: 358/2, alt: "Screenshot of 'Add Slack workspace service' screen on Buildkite. It shows an 'Add to Slack workspace' button" %> | ||||||
|
||||||
This will take you to Slack. Log in, and grant Buildkite the ability to post across your workspace. Once you have granted access, you can then edit the YAML of your pipelines to [configure notifications](/docs/pipelines/notifications). | ||||||
|
||||||
### Adding a channel-specific notification service | ||||||
|
||||||
In your [Organization's Notification Settings](https://buildkite.com/organizations/-/services), add a Slack notification service: | ||||||
|
||||||
|
@@ -36,7 +50,7 @@ With the configuration above, you'll receive notifications at the pipeline level | |||||
|
||||||
## Changing channels | ||||||
|
||||||
Once created, the Slack channel and workspace cannot be changed. To post to a different channel or workspace, create a new notification service. | ||||||
Once created, the Slack channel and workspace cannot be changed. To post to a different channel or workspace, create a new notification service. Alternatively, use a Slack Workspace to avoid the need to configure multiple notification services. Follow the process above to do so. | ||||||
|
||||||
## Conditional notifications | ||||||
|
||||||
|
@@ -69,3 +83,6 @@ Once you've found the matching Buildkite service and Slack app, confirm where an | |||||
### Create a new Slack notification service which posts | ||||||
|
||||||
Using the instructions above, [add a new Buildkite notification service](/docs/integrations/slack#adding-a-notification-service) with the same settings as the legacy integration. | ||||||
|
||||||
#### Slack Privacy Policy | ||||||
For more details, please checkout the [Slack Marketplace Privacy Policy](https://api.slack.com/slack-marketplace/guidelines#privacy) |
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
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
Oops, something went wrong.
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.
I reckon it's also worth calling out that the workspace integration adds support for Slack mentions, specifically because we request an additional scope to read user email addresses.