From a800f1c6ab563b4f63370837074a3ad7405d088e Mon Sep 17 00:00:00 2001 From: Luke Duncalfe Date: Tue, 22 Nov 2022 10:54:24 +1300 Subject: [PATCH 01/10] Add docs for GitLab for Slack notifications https://gitlab.com/gitlab-org/gitlab/-/issues/373321 --- doc/integration/slash_commands.md | 8 +- doc/user/admin_area/settings/index.md | 2 +- .../integrations/gitlab_slack_application.md | 160 ++++++++++++++---- 3 files changed, 137 insertions(+), 33 deletions(-) diff --git a/doc/integration/slash_commands.md b/doc/integration/slash_commands.md index 5eefa1138aabf8..beb7d112e6d358 100644 --- a/doc/integration/slash_commands.md +++ b/doc/integration/slash_commands.md @@ -20,6 +20,11 @@ We suggest you use the project name as the trigger command for simplicity and cl Assuming `project-name` is the trigger command, the slash commands are: +NOTE: +If you are using the [GitLab for Slack app](../user/project/integrations/gitlab_slack_application.md) for +your GitLab.com projects, [add the `gitlab` keyword at the beginning of the command](../user/project/integrations/gitlab_slack_application.md#slash-commands), +for example `/gitlab issue show `. + | Command | Effect | | ------- | ------ | | `/project-name help` | Shows all available slash commands. | @@ -32,9 +37,6 @@ Assuming `project-name` is the trigger command, the slash commands are: | `/project-name deploy to ` | [Deploys](#deploy-command) from the `` environment to the `` environment. | | `/project-name run ` | Executes the [ChatOps](../ci/chatops/index.md) job `` on the default branch. | -If you are using the [GitLab for Slack app](../user/project/integrations/gitlab_slack_application.md) for -your GitLab.com projects, [add the `gitlab` keyword at the beginning of the command](../user/project/integrations/gitlab_slack_application.md#usage). - ## Issue commands You can create a new issue, display issue details, and search up to 5 issues. diff --git a/doc/user/admin_area/settings/index.md b/doc/user/admin_area/settings/index.md index 2b5c3b5ee21f39..748111c67314fa 100644 --- a/doc/user/admin_area/settings/index.md +++ b/doc/user/admin_area/settings/index.md @@ -86,7 +86,7 @@ The **Integrations** settings contain: to receive invite email bounce events from Mailgun, if it is your email provider. - [PlantUML](../../../administration/integration/plantuml.md) - Allow rendering of PlantUML diagrams in documents. -- [Slack application](../../../user/project/integrations/gitlab_slack_application.md#configuration) - +- [Slack application](../../../user/project/integrations/gitlab_slack_application.md) - Slack integration allows you to interact with GitLab via slash commands in a chat window. This option is only available on GitLab.com, though it may be [available for self-managed instances in the future](https://gitlab.com/gitlab-org/gitlab/-/issues/28164). diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 50b52421a5af52..639ce638edda7e 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -16,7 +16,9 @@ for our plans to make the app configurable for all GitLab installations. Slack provides a native application that you can enable with your project's integrations on GitLab.com. -## Slack App Directory +## Installation + +### Installation through the Slack App Directory To enable the GitLab for Slack app for your workspace, install the [GitLab application](https://slack-platform.slack.com/apps/A676ADMV5-gitlab) @@ -25,7 +27,7 @@ from the [Slack App Directory](https://slack.com/apps). On the [GitLab for Slack app landing page](https://gitlab.com/-/profile/slack/edit), you can select a GitLab project to link with your Slack workspace. -## Configuration +### Installation through GitLab project settings Alternatively, you can configure the GitLab for Slack app with your project's integration settings. @@ -44,9 +46,45 @@ To enable the GitLab integration for your Slack workspace: You can also select **Reinstall GitLab for Slack app** to update the app in your Slack workspace to the latest version. See [Version history](#version-history) for details. -## Create a project alias for Slack +## Slash commands + +After installing the app, everyone in your Slack workspace can +use slash commands. + +Replace `` with the project full path, or create a shorter [project alias](#create-a-project-alias-for-slash-commands) for the slash commands. + +| Command | Effect | +| ------- | ------ | +| `/gitlab help` | Shows all available slash commands. | +| `/gitlab issue new <shift+return> <description>` | Creates a new issue with title `<title>` and description `<description>`. | +| `/gitlab <project> issue show <id>` | Shows the issue with ID `<id>`. | +| `/gitlab <project> issue close <id>` | Closes the issue with ID `<id>`. | +| `/gitlab <project> issue search <query>` | Shows up to 5 issues matching `<query>`. | +| `/gitlab <project> issue move <id> to <project>` | Moves the issue with ID `<id>` to `<project>`. | +| `/gitlab <project> issue comment <id> <shift+return> <comment>` | Adds a new comment with comment body `<comment>` to the issue with ID `<id>`. | +| `/gitlab <project> deploy <from> to <to>` | [Deploys](#the-deploy-slash-command) from the `<from>` environment to the `<to>` environment. | +| `/gitlab <project> run <job name> <arguments>` | Executes the [ChatOps](../../../ci/chatops/index.md) job `<job name>` on the default branch. | + +### The deploy slash command + +To deploy to an environment, GitLab tries to find a deployment +manual action in the pipeline. + +If there's only one action for a given environment, it is triggered. +If more than one action is defined, GitLab finds an action +name that equals the environment name to deploy to. + +The command returns an error if no matching action is found. + +### Authorizing your user + +When you perform your first slash command, you are asked to +authorize your Slack user on GitLab.com. + +### Create a project alias for slash commands -To create a project alias on GitLab.com for Slack integration: +By default slash commands expect a project's full path. To use a shorter alias +instead: 1. Go to your project's home page. 1. Go to **Settings > Integrations** (only visible on GitLab.com). @@ -55,43 +93,107 @@ To create a project alias on GitLab.com for Slack integration: select **Edit**. 1. Enter your desired alias, and select **Save changes**. -Some Slack commands require a project alias and fail with the following error -if the project alias is incorrect or missing from the command: +## Notifications -```plaintext -GitLab error: project or alias not found -``` +> Introduced in GitLab 15.7 -## Usage +Notifications allow GitLab to send messages Slack workspace channels for certain GitLab [events](#events-for-slack-notifications) (such as issue creation). -After installing the app, everyone in your Slack workspace can -use the [slash commands](../../../integration/slash_commands.md). -When you perform your first slash command, you are asked to -authorize your Slack user on GitLab.com. +### Notifications configuration -The only difference with the [manually configurable Slack slash commands](slack_slash_commands.md) -is that you must prefix all commands with the `/gitlab` keyword. For example, -to show the issue number `1001` under the `gitlab-org/gitlab` -project, you must run the following command: +1. Ensure your GitLab for Slack app has been [installed](#installation) for a project. +1. On the left sidebar of the project page, select **Settings > Integrations**. +1. Select **Slack application**. +1. In the **Trigger** section, select the checkboxes for each GitLab + event you want to receive a notification for in Slack. For a full list, see + [Events for Slack notifications](#events-for-slack-notifications). +1. Below each checkbox you enable enter the name of the channel that you want the notification to be sent to. For example, `#my-channel`. + - To send messages to multiple channels, enter multiple Slack channel names separated by commas. For example `#channel-one, #channel-two`. Multiple channels are limited to `10`. -```plaintext -/gitlab gitlab-org/gitlab issue show 1001 -``` + NOTE: + If the channel is private, you must also [add the GitLab for Slack app to the private channel](#private-channel-notifications). -## Version history +1. Select the **Notify only broken pipelines** checkbox to notify pipeline events only on failures. +1. In the **Branches for which notifications are to be sent** dropdown list, select which types of branches notifications should be sent for, if relevant to your events. +1. Leave the **Labels to be notified** field blank to receive all notifications, or + add labels that the issue or merge request must have to trigger a + notification. +1. Select **Save changes**. + +Your Slack workspace will now start receiving GitLab event notifications as configured. -In GitLab 15.0 and later, the GitLab for Slack app is updated to [Slack's new granular permissions model](https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3). While there is no change in functionality, you should reinstall the app. +### Private channel notifications + +To receive a notification in a private Slack channel the GitLab for Slack app must first be added to the channel: + +1. Mention the app in the private channel, by typing `@GitLab` and hit Return. +1. Select **Add to Channel**. + +### Events for Slack notifications + +The following events are available for Slack notifications: + +| Event name | Description | +|--------------------------------------------------------------------------|------------------------------------------------------| +| **Push** | A push to the repository. | +| **Issue** | An issue is created, updated, or closed. | +| **Confidential issue** | A confidential issue is created, updated, or closed. | +| **Merge request** | A merge request is created, updated, or merged. | +| **Note** | A comment is added. | +| **Confidential note** | A confidential note is added. | +| **Tag push** | A new tag is pushed to the repository. | +| **Pipeline** | A pipeline status changed. | +| **Wiki page** | A wiki page is created or updated. | +| **Deployment** | A deployment starts or finishes. | +| **Alert** | A new, unique alert is recorded. | +| [**Vulnerability**](../../application_security/vulnerabilities/index.md) | A new, unique vulnerability is recorded. | ## Troubleshooting -When you work with the GitLab for Slack app, the -[App Home](https://api.slack.com/start/overview#app_home) might not display properly. -As a workaround, ensure your app is up to date. +### Ensure the app is up to date + +Ensure the GitLab for Slack app is up to date in your Slack workspace to enjoy all the latest features of the app. + +Sometimes a new release of the GitLab for Slack app requires new permissions to be authorized before the features work in your Slack workspace. To update an existing Slack integration: -1. Go to your [chat settings](https://gitlab.com/-/profile/chat_names). -1. Next to your project, select **GitLab for Slack app**. -1. Select **Reinstall GitLab for Slack app**. +1. Choose any project that has been configured to work with the GitLab for Slack integration. +1. On the left sidebar of the project page, select **Settings > Integrations**. +1. Select **Slack application**. +1. Select **Reinstall Slack app**. + +You only need to do this once to update the GitLab for Slack app for all projects that use the integration. Alternatively, you can [configure a new Slack integration](https://about.gitlab.com/solutions/slack/). + +### Troubleshooting slash commands + +Some Slack commands require a project full path or alias and fail with the following error +if the project was unable to be found: + +```plaintext +GitLab error: project or alias not found +``` + +Check: + +1. The project full path is correct. +1. If using a [project alias](#create-a-project-alias-for-slash-commands), the alias is correct. +1. The GitLab for Slack app integration is [enabled for the project](#installation-through-gitlab-project-settings). + +### Troubleshooting notifications + +If you are not receiving notifications to a channel, check: + +- The channel name you configured is correct. +- If the channel is private, that you have [added the GitLab Slack app to the channel](#private-channel-notifications). + +### Troubleshooting the App Home + +If the [App Home](https://api.slack.com/start/overview#app_home) does not display properly, ensure your [app is up to date](#ensure-the-app-is-up-to-date). + +## Version history + +In GitLab 15.0 and later, the GitLab for Slack app is updated to [Slack's new granular permissions model](https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3). +While there is no change in functionality, you should [reinstall the app](#troubleshooting). -- GitLab From a5444ee00f5afdad3c4bbeb076f7604b30b162ae Mon Sep 17 00:00:00 2001 From: Ashraf Khamis <akhamis@gitlab.com> Date: Thu, 8 Dec 2022 00:24:38 +0000 Subject: [PATCH 02/10] Apply 45 suggestion(s) to 2 file(s) --- doc/integration/slash_commands.md | 14 ++- .../integrations/gitlab_slack_application.md | 98 +++++++++---------- 2 files changed, 55 insertions(+), 57 deletions(-) diff --git a/doc/integration/slash_commands.md b/doc/integration/slash_commands.md index beb7d112e6d358..a8f31da940a73e 100644 --- a/doc/integration/slash_commands.md +++ b/doc/integration/slash_commands.md @@ -13,18 +13,16 @@ working in Slack and Mattermost, you can use slash commands. Type the command as a message in your chat client to activate it. For Slack, this requires an [integration configuration](../user/project/integrations/slack_slash_commands.md). -Slash commands are scoped to a project -and require the trigger command specified during configuration. +Slash commands are scoped to a project and require +a specified trigger command during configuration. +You should use the project name as the trigger command. -We suggest you use the project name as the trigger command for simplicity and clarity. +If you're using the [GitLab for Slack app](../user/project/integrations/gitlab_slack_application.md) for +your GitLab.com projects, [add the `gitlab` keyword at the beginning of the command](../user/project/integrations/gitlab_slack_application.md#slash-commands) +(for example, `/gitlab <project-name> issue show <id>`). Assuming `project-name` is the trigger command, the slash commands are: -NOTE: -If you are using the [GitLab for Slack app](../user/project/integrations/gitlab_slack_application.md) for -your GitLab.com projects, [add the `gitlab` keyword at the beginning of the command](../user/project/integrations/gitlab_slack_application.md#slash-commands), -for example `/gitlab <project-name> issue show <id>`. - | Command | Effect | | ------- | ------ | | `/project-name help` | Shows all available slash commands. | diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 639ce638edda7e..a33a15ae9edd93 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -56,12 +56,12 @@ Replace `<project>` with the project full path, or create a shorter [project ali | Command | Effect | | ------- | ------ | | `/gitlab help` | Shows all available slash commands. | -| `/gitlab <project> issue new <title> <shift+return> <description>` | Creates a new issue with title `<title>` and description `<description>`. | -| `/gitlab <project> issue show <id>` | Shows the issue with ID `<id>`. | -| `/gitlab <project> issue close <id>` | Closes the issue with ID `<id>`. | +| `/gitlab <project> issue new <title> <shift+return> <description>` | Creates a new issue with the title `<title>` and description `<description>`. | +| `/gitlab <project> issue show <id>` | Shows the issue with the ID `<id>`. | +| `/gitlab <project> issue close <id>` | Closes the issue with the ID `<id>`. | | `/gitlab <project> issue search <query>` | Shows up to 5 issues matching `<query>`. | -| `/gitlab <project> issue move <id> to <project>` | Moves the issue with ID `<id>` to `<project>`. | -| `/gitlab <project> issue comment <id> <shift+return> <comment>` | Adds a new comment with comment body `<comment>` to the issue with ID `<id>`. | +| `/gitlab <project> issue move <id> to <project>` | Moves the issue with the ID `<id>` to `<project>`. | +| `/gitlab <project> issue comment <id> <shift+return> <comment>` | Adds a new comment with the comment body `<comment>` to the issue with the ID `<id>`. | | `/gitlab <project> deploy <from> to <to>` | [Deploys](#the-deploy-slash-command) from the `<from>` environment to the `<to>` environment. | | `/gitlab <project> run <job name> <arguments>` | Executes the [ChatOps](../../../ci/chatops/index.md) job `<job name>` on the default branch. | @@ -72,18 +72,18 @@ manual action in the pipeline. If there's only one action for a given environment, it is triggered. If more than one action is defined, GitLab finds an action -name that equals the environment name to deploy to. +name that matches the environment name to deploy to. The command returns an error if no matching action is found. ### Authorizing your user -When you perform your first slash command, you are asked to +When you perform your first slash command, you must authorize your Slack user on GitLab.com. ### Create a project alias for slash commands -By default slash commands expect a project's full path. To use a shorter alias +By default, slash commands expect a project full path. To use a shorter alias instead: 1. Go to your project's home page. @@ -93,40 +93,42 @@ instead: select **Edit**. 1. Enter your desired alias, and select **Save changes**. -## Notifications +## Slack notifications > Introduced in GitLab 15.7 -Notifications allow GitLab to send messages Slack workspace channels for certain GitLab [events](#events-for-slack-notifications) (such as issue creation). +With Slack notifications, GitLab can send messages to Slack workspace channels for certain GitLab [events](#events-for-slack-notifications) (for example, when an issue is created). -### Notifications configuration +### Configure notifications -1. Ensure your GitLab for Slack app has been [installed](#installation) for a project. -1. On the left sidebar of the project page, select **Settings > Integrations**. -1. Select **Slack application**. -1. In the **Trigger** section, select the checkboxes for each GitLab +To configure Slack notifications: + +1. On the top bar, select **Main menu > Projects** and find a project for which the GitLab for Slack app has been [installed](#installation). +1. On the left sidebar, select **Settings > Integrations**. +1. Select **GitLab for Slack app**. +1. In the **Trigger** section, select the checkbox for each GitLab event you want to receive a notification for in Slack. For a full list, see [Events for Slack notifications](#events-for-slack-notifications). -1. Below each checkbox you enable enter the name of the channel that you want the notification to be sent to. For example, `#my-channel`. - - To send messages to multiple channels, enter multiple Slack channel names separated by commas. For example `#channel-one, #channel-two`. Multiple channels are limited to `10`. +1. For each checkbox you select, enter the name of the channel that receives the notifications (for example, `#my-channel`). + - To send notifications to multiple Slack channels, enter the channel names separated by commas (for example, `#channel-one, #channel-two`). You can enter up to 10 channels. NOTE: - If the channel is private, you must also [add the GitLab for Slack app to the private channel](#private-channel-notifications). + If the channel is private, you must also [add the GitLab for Slack app to the private channel](#receive-notifications-to-a-private-channel). -1. Select the **Notify only broken pipelines** checkbox to notify pipeline events only on failures. -1. In the **Branches for which notifications are to be sent** dropdown list, select which types of branches notifications should be sent for, if relevant to your events. -1. Leave the **Labels to be notified** field blank to receive all notifications, or - add labels that the issue or merge request must have to trigger a +1. Select the **Notify only broken pipelines** checkbox to notify only on failures. +1. From the **Branches for which notifications are to be sent** dropdown list, select which branches you want to receive notifications (if relevant to your events). +1. Leave the **Labels to be notified** text box blank to receive all notifications, or + add labels the issue or merge request must have to trigger a notification. 1. Select **Save changes**. -Your Slack workspace will now start receiving GitLab event notifications as configured. +Your Slack workspace can now start receiving GitLab event notifications. -### Private channel notifications +### Receive notifications to a private channel -To receive a notification in a private Slack channel the GitLab for Slack app must first be added to the channel: +To receive notifications to a private Slack channel, you must add the GitLab for Slack app to the channel: -1. Mention the app in the private channel, by typing `@GitLab` and hit Return. +1. Mention the app in the channel by typing `@GitLab` and pressing <kbd>Enter</kbd>. 1. Select **Add to Channel**. ### Events for Slack notifications @@ -150,50 +152,48 @@ The following events are available for Slack notifications: ## Troubleshooting -### Ensure the app is up to date - -Ensure the GitLab for Slack app is up to date in your Slack workspace to enjoy all the latest features of the app. +### Update the GitLab for Slack app -Sometimes a new release of the GitLab for Slack app requires new permissions to be authorized before the features work in your Slack workspace. +New releases of the app might require permissions to be authorized before some features work in your Slack workspace. You should ensure the app is up to date in your Slack workspace to enjoy all the latest features. -To update an existing Slack integration: +To update your GitLab for Slack app: -1. Choose any project that has been configured to work with the GitLab for Slack integration. -1. On the left sidebar of the project page, select **Settings > Integrations**. -1. Select **Slack application**. -1. Select **Reinstall Slack app**. +1. On the top bar, select **Main menu > Projects** and find a project for which the GitLab for Slack app has been configured. +1. On the left sidebar, select **Settings > Integrations**. +1. Select **GitLab for Slack app**. +1. Select **Reinstall GitLab for Slack app**. -You only need to do this once to update the GitLab for Slack app for all projects that use the integration. +The GitLab for Slack app is updated for all projects that use the integration. Alternatively, you can [configure a new Slack integration](https://about.gitlab.com/solutions/slack/). -### Troubleshooting slash commands +### Project or alias not found -Some Slack commands require a project full path or alias and fail with the following error -if the project was unable to be found: +Some Slack commands must have a project full path or alias and fail with the following error +if the project cannot be found: ```plaintext GitLab error: project or alias not found ``` -Check: +As a workaround, ensure: -1. The project full path is correct. -1. If using a [project alias](#create-a-project-alias-for-slash-commands), the alias is correct. -1. The GitLab for Slack app integration is [enabled for the project](#installation-through-gitlab-project-settings). +- The project full path is correct. +- If using a [project alias](#create-a-project-alias-for-slash-commands), the alias is correct. +- The GitLab for Slack app integration is [enabled for the project](#installation-through-gitlab-project-settings). -### Troubleshooting notifications +### Notifications are not received to a channel -If you are not receiving notifications to a channel, check: +If you're not receiving notifications to a Slack channel, ensure: - The channel name you configured is correct. -- If the channel is private, that you have [added the GitLab Slack app to the channel](#private-channel-notifications). +- If the channel is private, you've [added the GitLab for Slack app to the channel](#receive-notifications-to-a-private-channel). -### Troubleshooting the App Home +### The App Home does not display properly -If the [App Home](https://api.slack.com/start/overview#app_home) does not display properly, ensure your [app is up to date](#ensure-the-app-is-up-to-date). +If the [App Home](https://api.slack.com/start/overview#app_home) does not display properly, ensure your [app is up to date](#update-the-gitlab-for-slack-app). ## Version history In GitLab 15.0 and later, the GitLab for Slack app is updated to [Slack's new granular permissions model](https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3). -While there is no change in functionality, you should [reinstall the app](#troubleshooting). +Although there is no change in functionality, you should [reinstall the app](#update-the-gitlab-for-slack-app). -- GitLab From d1e50508a2e550b40d50af7e45f06860ad93a6ae Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@eml.cc> Date: Mon, 12 Dec 2022 15:58:53 +1300 Subject: [PATCH 03/10] Remove 10 channels --- doc/user/project/integrations/gitlab_slack_application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index a33a15ae9edd93..3bc6acaca061b1 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -110,7 +110,7 @@ To configure Slack notifications: event you want to receive a notification for in Slack. For a full list, see [Events for Slack notifications](#events-for-slack-notifications). 1. For each checkbox you select, enter the name of the channel that receives the notifications (for example, `#my-channel`). - - To send notifications to multiple Slack channels, enter the channel names separated by commas (for example, `#channel-one, #channel-two`). You can enter up to 10 channels. + - To send notifications to multiple Slack channels, enter the channel names separated by commas (for example, `#channel-one, #channel-two`). NOTE: If the channel is private, you must also [add the GitLab for Slack app to the private channel](#receive-notifications-to-a-private-channel). -- GitLab From a6eea020c917b5a0393ec49a2fca19a4a2383265 Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@gitlab.com> Date: Mon, 12 Dec 2022 23:38:29 +0000 Subject: [PATCH 04/10] Apply 4 suggestion(s) to 1 file(s) --- .../project/integrations/gitlab_slack_application.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 3bc6acaca061b1..adc5b5505997d6 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -18,7 +18,7 @@ integrations on GitLab.com. ## Installation -### Installation through the Slack App Directory +### Through the Slack App Directory To enable the GitLab for Slack app for your workspace, install the [GitLab application](https://slack-platform.slack.com/apps/A676ADMV5-gitlab) @@ -27,7 +27,7 @@ from the [Slack App Directory](https://slack.com/apps). On the [GitLab for Slack app landing page](https://gitlab.com/-/profile/slack/edit), you can select a GitLab project to link with your Slack workspace. -### Installation through GitLab project settings +### Through GitLab project settings Alternatively, you can configure the GitLab for Slack app with your project's integration settings. @@ -48,8 +48,7 @@ to the latest version. See [Version history](#version-history) for details. ## Slash commands -After installing the app, everyone in your Slack workspace can -use slash commands. +After installing the GitLab for Slack app, everyone in your Slack workspace can use slash commands. Replace `<project>` with the project full path, or create a shorter [project alias](#create-a-project-alias-for-slash-commands) for the slash commands. @@ -76,7 +75,7 @@ name that matches the environment name to deploy to. The command returns an error if no matching action is found. -### Authorizing your user +### User authorization When you perform your first slash command, you must authorize your Slack user on GitLab.com. -- GitLab From b526e68477fecf4986a2e3dd9f6596d3fab52729 Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@eml.cc> Date: Tue, 13 Dec 2022 12:40:11 +1300 Subject: [PATCH 05/10] Update introduced in line --- doc/user/project/integrations/gitlab_slack_application.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index adc5b5505997d6..302610dd818ef4 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -94,7 +94,7 @@ instead: ## Slack notifications -> Introduced in GitLab 15.7 +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/381012) in GitLab 15.7. With Slack notifications, GitLab can send messages to Slack workspace channels for certain GitLab [events](#events-for-slack-notifications) (for example, when an issue is created). @@ -179,7 +179,7 @@ As a workaround, ensure: - The project full path is correct. - If using a [project alias](#create-a-project-alias-for-slash-commands), the alias is correct. -- The GitLab for Slack app integration is [enabled for the project](#installation-through-gitlab-project-settings). +- The GitLab for Slack app integration is [enabled for the project](#through-gitlab-project-settings). ### Notifications are not received to a channel -- GitLab From 373e4180e842517878477958ca0c76a3213e4f25 Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@gitlab.com> Date: Wed, 25 Jan 2023 22:06:21 +0000 Subject: [PATCH 06/10] Apply 1 suggestion(s) to 1 file(s) --- doc/user/project/integrations/gitlab_slack_application.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 302610dd818ef4..47e46538fb9e2a 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -109,7 +109,7 @@ To configure Slack notifications: event you want to receive a notification for in Slack. For a full list, see [Events for Slack notifications](#events-for-slack-notifications). 1. For each checkbox you select, enter the name of the channel that receives the notifications (for example, `#my-channel`). - - To send notifications to multiple Slack channels, enter the channel names separated by commas (for example, `#channel-one, #channel-two`). + - To send notifications to multiple Slack channels, enter up to 10 channel names separated by commas (for example, `#channel-one, #channel-two`). NOTE: If the channel is private, you must also [add the GitLab for Slack app to the private channel](#receive-notifications-to-a-private-channel). -- GitLab From 32ae450df7201c7f5faf2727d4a8ffba0a184f00 Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@eml.cc> Date: Tue, 31 Jan 2023 11:04:06 +1300 Subject: [PATCH 07/10] Add deprecation to Slack notification docs --- doc/user/project/integrations/gitlab_slack_application.md | 2 +- doc/user/project/integrations/slack.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 47e46538fb9e2a..3db7d2cc97a57b 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -109,7 +109,7 @@ To configure Slack notifications: event you want to receive a notification for in Slack. For a full list, see [Events for Slack notifications](#events-for-slack-notifications). 1. For each checkbox you select, enter the name of the channel that receives the notifications (for example, `#my-channel`). - - To send notifications to multiple Slack channels, enter up to 10 channel names separated by commas (for example, `#channel-one, #channel-two`). + - To send notifications to multiple Slack channels, enter up to 10 channel names separated by commas (for example, `#channel-one, #channel-two`). NOTE: If the channel is private, you must also [add the GitLab for Slack app to the private channel](#receive-notifications-to-a-private-channel). diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index d35c682b5d382c..1f9139593d0eae 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -4,7 +4,13 @@ group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Slack notifications integration **(FREE)** +# Slack notifications integration (deprecated for SaaS) **(FREE)** + +WARNING: +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411>) for GitLab SaaS customers in GitLab 15.10 +and is [planned for eventual removal](https://gitlab.com/groups/gitlab-org/-/epics/8673) at some time in the future. +GitLab SaaS customers should switch to using the [GitLab for Slack app integration](gitlab_slack_application.md) instead. +Self-managed customers should continue to use the Slack notifications integration for the time being. The Slack notifications integration enables your GitLab project to send events (such as issue creation) to your existing Slack team as notifications. Setting up -- GitLab From bc45c8a76b463f28c99c9bc4d22913277b31a18a Mon Sep 17 00:00:00 2001 From: Ashraf Khamis <akhamis@gitlab.com> Date: Tue, 31 Jan 2023 22:10:14 +0000 Subject: [PATCH 08/10] Apply 3 suggestion(s) to 1 file(s) --- doc/user/project/integrations/slack.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 1f9139593d0eae..0509825ac8e536 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -4,13 +4,13 @@ group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Slack notifications integration (deprecated for SaaS) **(FREE)** +# Slack notifications integration **(FREE)** WARNING: -This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411>) for GitLab SaaS customers in GitLab 15.10 -and is [planned for eventual removal](https://gitlab.com/groups/gitlab-org/-/epics/8673) at some time in the future. +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411) for GitLab SaaS customers +in GitLab 15.10 and is [planned for removal](https://gitlab.com/groups/gitlab-org/-/epics/8673). GitLab SaaS customers should switch to using the [GitLab for Slack app integration](gitlab_slack_application.md) instead. -Self-managed customers should continue to use the Slack notifications integration for the time being. +Self-managed GitLab customers can continue to use this feature. The Slack notifications integration enables your GitLab project to send events (such as issue creation) to your existing Slack team as notifications. Setting up -- GitLab From 5bccad6c6aa52623723b240cac9235231b313ddc Mon Sep 17 00:00:00 2001 From: Luke Duncalfe <lduncalfe@gitlab.com> Date: Mon, 6 Feb 2023 22:17:27 +0000 Subject: [PATCH 09/10] Apply 1 suggestion(s) to 1 file(s) --- doc/user/project/integrations/slack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 0509825ac8e536..58b34aa9ea417f 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411) for GitLab SaaS customers in GitLab 15.10 and is [planned for removal](https://gitlab.com/groups/gitlab-org/-/epics/8673). -GitLab SaaS customers should switch to using the [GitLab for Slack app integration](gitlab_slack_application.md) instead. +GitLab SaaS customers can use the [GitLab for Slack app integration](gitlab_slack_application.md) instead. Self-managed GitLab customers can continue to use this feature. The Slack notifications integration enables your GitLab project to send events -- GitLab From 1c32fdbc12335188cf47b9fc15374c117b75083c Mon Sep 17 00:00:00 2001 From: Ashraf Khamis <akhamis@gitlab.com> Date: Thu, 9 Feb 2023 23:10:33 +0000 Subject: [PATCH 10/10] Apply 1 suggestion(s) to 1 file(s) --- doc/user/project/integrations/slack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 58b34aa9ea417f..2aee7040ad2100 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/372411) for GitLab SaaS customers in GitLab 15.10 and is [planned for removal](https://gitlab.com/groups/gitlab-org/-/epics/8673). -GitLab SaaS customers can use the [GitLab for Slack app integration](gitlab_slack_application.md) instead. +GitLab SaaS customers can use the [GitLab for Slack app](gitlab_slack_application.md) instead. Self-managed GitLab customers can continue to use this feature. The Slack notifications integration enables your GitLab project to send events -- GitLab