From 55c2c6ce6bfb0966661429fdb91169e52f2cbbbc Mon Sep 17 00:00:00 2001 From: "Z.J. van de Weg" Date: Fri, 18 Nov 2016 14:19:25 +0100 Subject: Add framework for docs on Mattermost commands [ci skip] --- .../img/mattermost_enable_custom_commands.png | Bin 0 -> 42288 bytes doc/project_services/mattermost_command.md | 42 +++++++++++++++++++++ doc/project_services/project_services.md | 1 + 3 files changed, 43 insertions(+) create mode 100644 doc/project_services/img/mattermost_enable_custom_commands.png create mode 100644 doc/project_services/mattermost_command.md diff --git a/doc/project_services/img/mattermost_enable_custom_commands.png b/doc/project_services/img/mattermost_enable_custom_commands.png new file mode 100644 index 00000000000..a10bda7e190 Binary files /dev/null and b/doc/project_services/img/mattermost_enable_custom_commands.png differ diff --git a/doc/project_services/mattermost_command.md b/doc/project_services/mattermost_command.md new file mode 100644 index 00000000000..1c455c0e891 --- /dev/null +++ b/doc/project_services/mattermost_command.md @@ -0,0 +1,42 @@ +# Mattermost Commands + +Mattermost commands give users an extra interface to perform common operations +from the chat environment. This allows one to, for example, create an issue as +soon as the idea was discussed in Mattermost. + +## Configuration + +### On Mattermost + +On Mattermost, an administrator has to enable custom slash commands. To do this, +log on, and go to the system console. + +Click **Custom integrations**, and enable the custom slash commands and don't +forget to save your settings. + +![Enable custom slash commands](img/mattermost_enable_custom_commands.png) + +Now go back to your team page, and go the the configuration page for a new +slash command. + +**Integrations** > **Slash Command** > **Add Slash Command** + +### On GitLab + +On the project you want to configure the slash commands for, go to the +Mattermost Command service. Under settings > **Project Services**. + +A screen will appear with all the values you can copy to the Mattermost page you +have just opened. + +**Insert screenshot here** + +## Usage + +A users first interaction with the newly created slash commands will trigger an +authorisation process. This process connects your Mattermost user with your +GitLab user. + +After these steps are performed, you can start interacting with GitLab. Maybe +start with `/your-trigger issue show 1` and see what your first issue was on +this project! diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index 4442b7c1742..93d558df982 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -42,6 +42,7 @@ further configuration instructions and details. Contributions are welcome. | [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | | [JIRA](jira.md) | JIRA issue tracker | | JetBrains TeamCity CI | A continuous integration and build server | +| [Mattermost Commands](mattermost_command.md) | Mattermost slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | -- cgit v1.2.1 From 0cc4c14514028bead4c668c957cbeb23f4f0f845 Mon Sep 17 00:00:00 2001 From: "Z.J. van de Weg" Date: Mon, 21 Nov 2016 14:52:29 +0100 Subject: Add screenshot in docs [ci skip] --- .../img/mattermost_config_help.png | Bin 0 -> 159971 bytes doc/project_services/mattermost_command.md | 42 --------------------- doc/project_services/mattermost_slash_commands.md | 42 +++++++++++++++++++++ doc/project_services/project_services.md | 2 +- 4 files changed, 43 insertions(+), 43 deletions(-) create mode 100644 doc/project_services/img/mattermost_config_help.png delete mode 100644 doc/project_services/mattermost_command.md create mode 100644 doc/project_services/mattermost_slash_commands.md diff --git a/doc/project_services/img/mattermost_config_help.png b/doc/project_services/img/mattermost_config_help.png new file mode 100644 index 00000000000..d0b64c058af Binary files /dev/null and b/doc/project_services/img/mattermost_config_help.png differ diff --git a/doc/project_services/mattermost_command.md b/doc/project_services/mattermost_command.md deleted file mode 100644 index 1c455c0e891..00000000000 --- a/doc/project_services/mattermost_command.md +++ /dev/null @@ -1,42 +0,0 @@ -# Mattermost Commands - -Mattermost commands give users an extra interface to perform common operations -from the chat environment. This allows one to, for example, create an issue as -soon as the idea was discussed in Mattermost. - -## Configuration - -### On Mattermost - -On Mattermost, an administrator has to enable custom slash commands. To do this, -log on, and go to the system console. - -Click **Custom integrations**, and enable the custom slash commands and don't -forget to save your settings. - -![Enable custom slash commands](img/mattermost_enable_custom_commands.png) - -Now go back to your team page, and go the the configuration page for a new -slash command. - -**Integrations** > **Slash Command** > **Add Slash Command** - -### On GitLab - -On the project you want to configure the slash commands for, go to the -Mattermost Command service. Under settings > **Project Services**. - -A screen will appear with all the values you can copy to the Mattermost page you -have just opened. - -**Insert screenshot here** - -## Usage - -A users first interaction with the newly created slash commands will trigger an -authorisation process. This process connects your Mattermost user with your -GitLab user. - -After these steps are performed, you can start interacting with GitLab. Maybe -start with `/your-trigger issue show 1` and see what your first issue was on -this project! diff --git a/doc/project_services/mattermost_slash_commands.md b/doc/project_services/mattermost_slash_commands.md new file mode 100644 index 00000000000..b5cfc77f54a --- /dev/null +++ b/doc/project_services/mattermost_slash_commands.md @@ -0,0 +1,42 @@ +# Mattermost Commands + +Mattermost commands give users an extra interface to perform common operations +from the chat environment. This allows one to, for example, create an issue as +soon as the idea was discussed in Mattermost. + +## Configuration + +### On Mattermost + +On Mattermost, an administrator has to enable custom slash commands. To do this, +log on, and go to the system console. + +Click **Custom integrations**, and enable the custom slash commands and don't +forget to save your settings. + +![Enable custom slash commands](img/mattermost_enable_custom_commands.png) + +Now go back to your team page, and go the the configuration page for a new +slash command. + +**Integrations** > **Slash Command** > **Add Slash Command** + +### On GitLab + +On the project you want to configure the slash commands for, go to the +Mattermost Command service. Under settings > **Project Services**. + +A screen will appear with all the values you can copy to the Mattermost page you +have just opened. + +![Mattermost setup instructions](img/mattermost_config_help.png) + +## Usage + +A users first interaction with the newly created slash commands will trigger an +authorisation process. This process connects your Mattermost user with your +GitLab user. + +After these steps are performed, you can start interacting with GitLab. Maybe +start with `/your-trigger issue show 1` and see what your first issue was on +this project! diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index 93d558df982..57b731e297b 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -42,7 +42,7 @@ further configuration instructions and details. Contributions are welcome. | [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | | [JIRA](jira.md) | JIRA issue tracker | | JetBrains TeamCity CI | A continuous integration and build server | -| [Mattermost Commands](mattermost_command.md) | Mattermost slash commands | +| [Mattermost Slash Commands](mattermost_slash_commands.md) | Mattermost slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | -- cgit v1.2.1 From 2a21a347fde928e548b4543fd21ba73633fbb757 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 21 Nov 2016 22:57:03 +0100 Subject: Refactor Mattermost slash commands docs [ci skip] --- .../img/mattermost_add_slash_command.png | Bin 0 -> 23150 bytes doc/project_services/img/mattermost_bot_auth.png | Bin 0 -> 21031 bytes .../img/mattermost_bot_available_commands.png | Bin 0 -> 23504 bytes .../img/mattermost_config_help.png | Bin 159971 -> 176610 bytes .../img/mattermost_console_integrations.png | Bin 0 -> 114850 bytes .../img/mattermost_enable_custom_commands.png | Bin 42288 -> 0 bytes .../img/mattermost_goto_console.png | Bin 0 -> 22802 bytes .../img/mattermost_slash_command_configuration.png | Bin 0 -> 60927 bytes .../img/mattermost_team_integrations.png | Bin 0 -> 12171 bytes doc/project_services/mattermost_slash_commands.md | 134 +++++++++++++++++---- doc/project_services/project_services.md | 2 +- 11 files changed, 112 insertions(+), 24 deletions(-) create mode 100644 doc/project_services/img/mattermost_add_slash_command.png create mode 100644 doc/project_services/img/mattermost_bot_auth.png create mode 100644 doc/project_services/img/mattermost_bot_available_commands.png create mode 100644 doc/project_services/img/mattermost_console_integrations.png delete mode 100644 doc/project_services/img/mattermost_enable_custom_commands.png create mode 100644 doc/project_services/img/mattermost_goto_console.png create mode 100644 doc/project_services/img/mattermost_slash_command_configuration.png create mode 100644 doc/project_services/img/mattermost_team_integrations.png diff --git a/doc/project_services/img/mattermost_add_slash_command.png b/doc/project_services/img/mattermost_add_slash_command.png new file mode 100644 index 00000000000..6d45bce8004 Binary files /dev/null and b/doc/project_services/img/mattermost_add_slash_command.png differ diff --git a/doc/project_services/img/mattermost_bot_auth.png b/doc/project_services/img/mattermost_bot_auth.png new file mode 100644 index 00000000000..19c4735194f Binary files /dev/null and b/doc/project_services/img/mattermost_bot_auth.png differ diff --git a/doc/project_services/img/mattermost_bot_available_commands.png b/doc/project_services/img/mattermost_bot_available_commands.png new file mode 100644 index 00000000000..04fa4b3ea88 Binary files /dev/null and b/doc/project_services/img/mattermost_bot_available_commands.png differ diff --git a/doc/project_services/img/mattermost_config_help.png b/doc/project_services/img/mattermost_config_help.png index d0b64c058af..3e38bf0abc6 100644 Binary files a/doc/project_services/img/mattermost_config_help.png and b/doc/project_services/img/mattermost_config_help.png differ diff --git a/doc/project_services/img/mattermost_console_integrations.png b/doc/project_services/img/mattermost_console_integrations.png new file mode 100644 index 00000000000..eecec0950a8 Binary files /dev/null and b/doc/project_services/img/mattermost_console_integrations.png differ diff --git a/doc/project_services/img/mattermost_enable_custom_commands.png b/doc/project_services/img/mattermost_enable_custom_commands.png deleted file mode 100644 index a10bda7e190..00000000000 Binary files a/doc/project_services/img/mattermost_enable_custom_commands.png and /dev/null differ diff --git a/doc/project_services/img/mattermost_goto_console.png b/doc/project_services/img/mattermost_goto_console.png new file mode 100644 index 00000000000..3576758b331 Binary files /dev/null and b/doc/project_services/img/mattermost_goto_console.png differ diff --git a/doc/project_services/img/mattermost_slash_command_configuration.png b/doc/project_services/img/mattermost_slash_command_configuration.png new file mode 100644 index 00000000000..06416b0d068 Binary files /dev/null and b/doc/project_services/img/mattermost_slash_command_configuration.png differ diff --git a/doc/project_services/img/mattermost_team_integrations.png b/doc/project_services/img/mattermost_team_integrations.png new file mode 100644 index 00000000000..9086cf1c136 Binary files /dev/null and b/doc/project_services/img/mattermost_team_integrations.png differ diff --git a/doc/project_services/mattermost_slash_commands.md b/doc/project_services/mattermost_slash_commands.md index b5cfc77f54a..36b72de1be0 100644 --- a/doc/project_services/mattermost_slash_commands.md +++ b/doc/project_services/mattermost_slash_commands.md @@ -1,42 +1,130 @@ -# Mattermost Commands +# Mattermost slash commands + +> Introduced in GitLab 8.14 Mattermost commands give users an extra interface to perform common operations from the chat environment. This allows one to, for example, create an issue as soon as the idea was discussed in Mattermost. +## Prerequisites + +Mattermost 3.4 and up is required. + +If you have the Omnibus GitLab package installed, Mattermost is already bundled +in it. All you have to do is configure it. Read more in the +[Omnibus GitLab Mattermost documentation][omnimatdocs]. + ## Configuration -### On Mattermost +The configuration consists of two parts. First you need to enable the slash +commands in Mattermost and then enable the service in GitLab. + + +### Step 1. Enable custom slash commands in Mattermost + +The first thing to do in Mattermost is to enable the custom slash commands from +the administrator console. + +1. Log in with an account that has admin privileges and navigate to the system + console. + + ![Mattermost go to console](img/mattermost_goto_console.png) + + --- + +1. Click **Custom integrations** and set **Enable Custom Slash Commands** to + true. + + ![Mattermost console](img/mattermost_console_integrations.png) + + --- + +1. Click **Save** at the bottom to save the changes. + +### Step 2. Create a new custom command in Mattermost + +Now that you have enabled the custom slash commands: + +1. Back to your team page settings, you should see the **Integrations** option. + + ![Mattermost team integrations](img/mattermost_team_integrations.png) + + --- + +1. Go to the **Slash Command** integration and add a new one by clicking the + **Add Slash Command** button. + + ![Mattermost add command](img/mattermost_add_slash_command.png) + + --- + +1. Fill in the options for the custom command. + + ![Mattermost add command configuration](img/mattermost_slash_command_configuration.png) + + > **Note:** + When configuring the GitLab Mattermost command service in the next step, + you will be presented with some predefined values to paste into the + Mattermost slash command settings. + +1. After you setup all the values, copy the token (we will use it below) and + click **Done**. + +> +[**➔ Read more on Mattermost slash commands**][mmslashdocs]. + +### Step 3. Configure GitLab + +1. Go to your project's settings **Services ➔ Mattermost command**. A screen + will appear with all the values you can copy to the Mattermost page in the + previous step. + + ![Mattermost setup instructions](img/mattermost_config_help.png) + +1. Paste the Mattermost token you copied when setting up the Mattermost slash + command and check the **Active** checkbox. +1. Click **Save changes** for the changes to take effect. + +## Authorizing Mattermost to interact with GitLab + +The first time a user will interact with the newly created slash commands, +Mattermost will trigger an authorization process. -On Mattermost, an administrator has to enable custom slash commands. To do this, -log on, and go to the system console. +![Mattermost bot authorize](img/mattermost_bot_auth.png) -Click **Custom integrations**, and enable the custom slash commands and don't -forget to save your settings. +This will connect connect your Mattermost user with your GitLab user. You can +see all authorized chat accounts in your profile's page under **Chat**. -![Enable custom slash commands](img/mattermost_enable_custom_commands.png) +When the authorization process is complete, you can start interacting with +GitLab using the Mattermost commands. -Now go back to your team page, and go the the configuration page for a new -slash command. +## Available slash commands -**Integrations** > **Slash Command** > **Add Slash Command** +The available slash commands so far are: -### On GitLab +- `/ issue create \n<description>` - Create a new issue to the + project that `<trigger>` is tied to. +- `/<trigger> issue show <issue-number>` - Show the issue with ID `<issue-number>` + from the project that `<trigger>` is tied to. +- `/<trigger> deploy <environment> to <environment>` - Start the CI job that + deploys from an environment to another, for example `staging` to `production`. + CI must be properly configured. -On the project you want to configure the slash commands for, go to the -Mattermost Command service. Under settings > **Project Services**. +If you enabled autocomplete when you created the Mattermost command, you can +use the autocomplete hint to see the available commands that can interact +with GitLab. If for example the autocomplete hint was set to `help` and the +command trigger word to `my-project`, then to see all available command type: -A screen will appear with all the values you can copy to the Mattermost page you -have just opened. +``` +/my-project help +``` -![Mattermost setup instructions](img/mattermost_config_help.png) +![Mattermost bot available commands](img/mattermost_bot_available_commands.png) -## Usage +## Permissions -A users first interaction with the newly created slash commands will trigger an -authorisation process. This process connects your Mattermost user with your -GitLab user. +The permissions to run the [available commands](#available-commands) derive from +the [permissions you have on the project](../user/permissions.md#project). -After these steps are performed, you can start interacting with GitLab. Maybe -start with `/your-trigger issue show 1` and see what your first issue was on -this project! +[omnimatdocs]: https://docs.gitlab.com/omnibus/gitlab-mattermost/ +[mmslashdocs]: https://docs.mattermost.com/developer/slash-commands.html diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index 57b731e297b..cba183c9f15 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -42,7 +42,7 @@ further configuration instructions and details. Contributions are welcome. | [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | | [JIRA](jira.md) | JIRA issue tracker | | JetBrains TeamCity CI | A continuous integration and build server | -| [Mattermost Slash Commands](mattermost_slash_commands.md) | Mattermost slash commands | +| [Mattermost command](mattermost_slash_commands.md) | Mattermost slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | -- cgit v1.2.1 From 25817c2741b988fbd37c2f46e4c0e6cfb8b3764e Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis <axilleas@axilleas.me> Date: Tue, 22 Nov 2016 11:02:46 +0100 Subject: Restructure steps for MM slash commands service [ci skip] --- .../img/mattermost_bot_available_commands.png | Bin 23504 -> 12746 bytes .../img/mattermost_gitlab_token.png | Bin 0 -> 7879 bytes .../img/mattermost_slash_command_token.png | Bin 0 -> 20415 bytes doc/project_services/mattermost_slash_commands.md | 95 +++++++++++++-------- doc/project_services/project_services.md | 2 +- 5 files changed, 62 insertions(+), 35 deletions(-) create mode 100644 doc/project_services/img/mattermost_gitlab_token.png create mode 100644 doc/project_services/img/mattermost_slash_command_token.png diff --git a/doc/project_services/img/mattermost_bot_available_commands.png b/doc/project_services/img/mattermost_bot_available_commands.png index 04fa4b3ea88..f912a639cc5 100644 Binary files a/doc/project_services/img/mattermost_bot_available_commands.png and b/doc/project_services/img/mattermost_bot_available_commands.png differ diff --git a/doc/project_services/img/mattermost_gitlab_token.png b/doc/project_services/img/mattermost_gitlab_token.png new file mode 100644 index 00000000000..3f4f26aab35 Binary files /dev/null and b/doc/project_services/img/mattermost_gitlab_token.png differ diff --git a/doc/project_services/img/mattermost_slash_command_token.png b/doc/project_services/img/mattermost_slash_command_token.png new file mode 100644 index 00000000000..320e263026a Binary files /dev/null and b/doc/project_services/img/mattermost_slash_command_token.png differ diff --git a/doc/project_services/mattermost_slash_commands.md b/doc/project_services/mattermost_slash_commands.md index 36b72de1be0..1507dfa3abd 100644 --- a/doc/project_services/mattermost_slash_commands.md +++ b/doc/project_services/mattermost_slash_commands.md @@ -12,7 +12,7 @@ Mattermost 3.4 and up is required. If you have the Omnibus GitLab package installed, Mattermost is already bundled in it. All you have to do is configure it. Read more in the -[Omnibus GitLab Mattermost documentation][omnimatdocs]. +[Omnibus GitLab Mattermost documentation][omnimmdocs]. ## Configuration @@ -22,7 +22,7 @@ commands in Mattermost and then enable the service in GitLab. ### Step 1. Enable custom slash commands in Mattermost -The first thing to do in Mattermost is to enable the custom slash commands from +The first thing to do in Mattermost is to enable custom slash commands from the administrator console. 1. Log in with an account that has admin privileges and navigate to the system @@ -41,50 +41,74 @@ the administrator console. 1. Click **Save** at the bottom to save the changes. -### Step 2. Create a new custom command in Mattermost +### Step 2. Open the Mattermost slash commands service in GitLab -Now that you have enabled the custom slash commands: +1. Open a new tab for GitLab and go to your project's settings + **Services ➔ Mattermost command**. A screen will appear with all the values you + need to copy in Mattermost as described in the next step. Leave the window open. -1. Back to your team page settings, you should see the **Integrations** option. + >**Note:** + GitLab will propose some values for the Mattermost settings. The only one + required to copy-paste as-is is the **Request URL**, all the others are just + suggestions. + + ![Mattermost setup instructions](img/mattermost_config_help.png) + + --- + +1. Proceed to the next step and create a slash command in Mattermost with the + above values. + +### Step 3. Create a new custom slash command in Mattermost + +Now that you have enabled the custom slash commands in Mattermost and opened +the Mattermost slash commands service in GitLab, it's time to copy these values +in a new slash command. + +1. Back to Mattermost, under your team page settings, you should see the + **Integrations** option. ![Mattermost team integrations](img/mattermost_team_integrations.png) --- -1. Go to the **Slash Command** integration and add a new one by clicking the +1. Go to the **Slash Commands** integration and add a new one by clicking the **Add Slash Command** button. ![Mattermost add command](img/mattermost_add_slash_command.png) --- -1. Fill in the options for the custom command. +1. Fill in the options for the custom command as described in + [step 2](#step-2-open-the-mattermost-slash-commands-service-in-gitlab). - ![Mattermost add command configuration](img/mattermost_slash_command_configuration.png) + >**Note:** + If you plan on connecting multiple projects, pick a slash command trigger + word that relates to your projects such as `/gitlab-project-name` or even + just `/project-name`. Only use `/gitlab` if you will only connect a single + project to your Mattermost team. - > **Note:** - When configuring the GitLab Mattermost command service in the next step, - you will be presented with some predefined values to paste into the - Mattermost slash command settings. + ![Mattermost add command configuration](img/mattermost_slash_command_configuration.png) 1. After you setup all the values, copy the token (we will use it below) and click **Done**. -> -[**➔ Read more on Mattermost slash commands**][mmslashdocs]. + ![Mattermost slash command token](img/mattermost_slash_command_token.png) -### Step 3. Configure GitLab +### Step 4. Copy the Mattermost token into the Mattermost slash command service -1. Go to your project's settings **Services ➔ Mattermost command**. A screen - will appear with all the values you can copy to the Mattermost page in the - previous step. +1. In GitLab, paste the Mattermost token you copied in the previous step and + check the **Active** checkbox. - ![Mattermost setup instructions](img/mattermost_config_help.png) + ![Mattermost copy token to GitLab](img/mattermost_gitlab_token.png) -1. Paste the Mattermost token you copied when setting up the Mattermost slash - command and check the **Active** checkbox. 1. Click **Save changes** for the changes to take effect. +--- + +You are now set to start using slash commands in Mattermost that talk to the +GitLab project you configured. + ## Authorizing Mattermost to interact with GitLab The first time a user will interact with the newly created slash commands, @@ -92,7 +116,7 @@ Mattermost will trigger an authorization process. ![Mattermost bot authorize](img/mattermost_bot_auth.png) -This will connect connect your Mattermost user with your GitLab user. You can +This will connect your Mattermost user with your GitLab user. You can see all authorized chat accounts in your profile's page under **Chat**. When the authorization process is complete, you can start interacting with @@ -102,18 +126,14 @@ GitLab using the Mattermost commands. The available slash commands so far are: -- `/<trigger> issue create <title>\n<description>` - Create a new issue to the - project that `<trigger>` is tied to. -- `/<trigger> issue show <issue-number>` - Show the issue with ID `<issue-number>` - from the project that `<trigger>` is tied to. -- `/<trigger> deploy <environment> to <environment>` - Start the CI job that - deploys from an environment to another, for example `staging` to `production`. - CI must be properly configured. +| Command | Description | Example | +| ------- | ----------- | ------- | +| `/<trigger> issue create <title>\n<description>` | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | `/trigger issue create We need to change the homepage` | +| `/<trigger> issue show <issue-number>` | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/trigger issue show 42` | +| `/<trigger> deploy <environment> to <environment>` | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured][ciyaml]. | `/trigger deploy staging to production` | -If you enabled autocomplete when you created the Mattermost command, you can -use the autocomplete hint to see the available commands that can interact -with GitLab. If for example the autocomplete hint was set to `help` and the -command trigger word to `my-project`, then to see all available command type: +To see a list of available commands that can interact with GitLab, type the +trigger word followed by `help`: ``` /my-project help @@ -126,5 +146,12 @@ command trigger word to `my-project`, then to see all available command type: The permissions to run the [available commands](#available-commands) derive from the [permissions you have on the project](../user/permissions.md#project). -[omnimatdocs]: https://docs.gitlab.com/omnibus/gitlab-mattermost/ +## Further reading + +- [Mattermost slash commands documentation][mmslashdocs] +- [Omnibus GitLab Mattermost][omnimmdocs] + + +[omnimmdocs]: https://docs.gitlab.com/omnibus/gitlab-mattermost/ [mmslashdocs]: https://docs.mattermost.com/developer/slash-commands.html +[ciyaml]: ../ci/yaml/README.md diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index cba183c9f15..890f7525b0e 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -42,7 +42,7 @@ further configuration instructions and details. Contributions are welcome. | [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | | [JIRA](jira.md) | JIRA issue tracker | | JetBrains TeamCity CI | A continuous integration and build server | -| [Mattermost command](mattermost_slash_commands.md) | Mattermost slash commands | +| [Mattermost slash commands](mattermost_slash_commands.md) | Mattermost chat and ChatOps slash commands | | PivotalTracker | Project Management Software (Source Commits Endpoint) | | Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | | [Redmine](redmine.md) | Redmine issue tracker | -- cgit v1.2.1