debian-mirror-gitlab/doc/user/project/integrations/gitlab_slack_application.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

98 lines
3.8 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
2022-11-25 23:54:43 +05:30
stage: Manage
2021-10-27 15:23:28 +05:30
group: Integrations
2022-11-25 23:54:43 +05:30
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
2020-10-24 23:57:45 +05:30
---
2023-01-13 00:05:48 +05:30
# GitLab for Slack app **(FREE SAAS)**
2019-07-31 22:56:46 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2023-01-13 00:05:48 +05:30
The GitLab for Slack app is only configurable for GitLab.com. It does **not**
work for on-premises installations where you can configure
[Slack slash commands](slack_slash_commands.md) instead. See
[Slack application integration for self-managed instances](https://gitlab.com/gitlab-org/gitlab/-/issues/28164)
for our plans to make the app configurable for all GitLab installations.
2019-07-31 22:56:46 +05:30
2023-01-13 00:05:48 +05:30
Slack provides a native application that you can enable with your project's
2019-07-31 22:56:46 +05:30
integrations on GitLab.com.
## Slack App Directory
2023-01-13 00:05:48 +05:30
To enable the GitLab for Slack app for your workspace,
install the [GitLab application](https://slack-platform.slack.com/apps/A676ADMV5-gitlab)
from the [Slack App Directory](https://slack.com/apps).
2019-07-31 22:56:46 +05:30
2023-01-13 00:05:48 +05:30
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.
2019-07-31 22:56:46 +05:30
## Configuration
2023-01-13 00:05:48 +05:30
Alternatively, you can configure the GitLab for Slack app with your project's
2019-07-31 22:56:46 +05:30
integration settings.
2023-01-13 00:05:48 +05:30
You must have the appropriate permissions for your Slack
workspace to be able to install a new application. See
[Add apps to your Slack workspace](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace).
2019-07-31 22:56:46 +05:30
2022-07-16 23:28:13 +05:30
To enable the GitLab integration for your Slack workspace:
2019-07-31 22:56:46 +05:30
2020-10-24 23:57:45 +05:30
1. Go to your project's **Settings > Integration > Slack application** (only
2020-05-24 23:13:21 +05:30
visible on GitLab.com).
2022-07-16 23:28:13 +05:30
1. Select **Install Slack app**.
1. Select **Allow** on Slack's confirmation screen.
2019-07-31 22:56:46 +05:30
2022-07-16 23:28:13 +05:30
You can also select **Reinstall Slack app** to update the app in your Slack workspace
2023-01-13 00:05:48 +05:30
to the latest version. See [Version history](#version-history) for details.
2022-07-16 23:28:13 +05:30
2020-05-24 23:13:21 +05:30
## Create a project alias for Slack
To create a project alias on GitLab.com for Slack integration:
1. Go to your project's home page.
2023-01-13 00:05:48 +05:30
1. Go to **Settings > Integrations** (only visible on GitLab.com).
2022-05-07 20:08:51 +05:30
1. On the **Integrations** page, select **Slack application**.
2020-05-24 23:13:21 +05:30
1. The current **Project Alias**, if any, is displayed. To edit this value,
2022-05-07 20:08:51 +05:30
select **Edit**.
1. Enter your desired alias, and select **Save changes**.
2020-05-24 23:13:21 +05:30
2023-01-13 00:05:48 +05:30
Some Slack commands require a project alias and fail with the following error
2020-05-24 23:13:21 +05:30
if the project alias is incorrect or missing from the command:
```plaintext
GitLab error: project or alias not found
```
2019-07-31 22:56:46 +05:30
## Usage
2023-01-13 00:05:48 +05:30
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.
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
The only difference with the [manually configurable Slack slash commands](slack_slash_commands.md)
2023-01-13 00:05:48 +05:30
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:
2019-07-31 22:56:46 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-12-21 20:55:43 +05:30
/gitlab gitlab-org/gitlab issue show 1001
2019-07-31 22:56:46 +05:30
```
2022-07-16 23:28:13 +05:30
## Version history
2023-01-13 00:05:48 +05:30
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.
2022-11-25 23:54:43 +05:30
## Troubleshooting
2023-01-13 00:05:48 +05:30
When you work with the GitLab for Slack app, the
2022-11-25 23:54:43 +05:30
[App Home](https://api.slack.com/start/overview#app_home) might not display properly.
As a workaround, ensure your app is up to date.
To update an existing Slack integration:
1. Go to your [chat settings](https://gitlab.com/-/profile/chat_names).
1. Next to your project, select **Slack application**.
1. Select **Reinstall Slack app**.
Alternatively, you can [configure a new Slack integration](https://about.gitlab.com/solutions/slack/).