debian-mirror-gitlab/doc/integration/slash_commands.md

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

52 lines
2.6 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-10-27 15:23:28 +05:30
stage: Ecosystem
group: Integrations
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-11-11 11:23:49 +05:30
# Slash commands in Mattermost and Slack **(FREE)**
2017-09-10 17:25:29 +05:30
2021-11-18 22:05:49 +05:30
> - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24780) from GitLab Ultimate to GitLab Free in 11.9.
2019-07-07 11:18:12 +05:30
2021-11-11 11:23:49 +05:30
If you want to control and view GitLab content while you're
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).
2017-09-10 17:25:29 +05:30
2021-11-11 11:23:49 +05:30
Slash commands are scoped to a project
and require the trigger command specified during configuration.
2017-09-10 17:25:29 +05:30
2021-11-11 11:23:49 +05:30
We suggest you use the project name as the trigger command for simplicity and clarity.
2017-09-10 17:25:29 +05:30
2021-11-11 11:23:49 +05:30
Assuming `project-name` is the trigger command, the slash commands are:
2017-09-10 17:25:29 +05:30
| Command | Effect |
| ------- | ------ |
2021-11-11 11:23:49 +05:30
| `/project-name help` | Shows all available slash commands. |
| `/project-name issue new <title> <shift+return> <description>` | Creates a new issue with title `<title>` and description `<description>`. |
| `/project-name issue show <id>` | Shows the issue with ID `<id>`. |
| `/project-name issue close <id>` | Closes the issue with ID `<id>`. |
| `/project-name issue search <query>` | Shows up to 5 issues matching `<query>`. |
| `/project-name issue move <id> to <project>` | Moves the issue with ID `<id>` to `<project>`. |
| `/project-name issue comment <id> <shift+return> <comment>` | Adds a new comment with comment body `<comment>` to the issue with ID `<id>`. |
| `/project-name deploy <from> to <to>` | [Deploys](#deploy-command) from the `<from>` environment to the `<to>` environment. |
| `/project-name run <job name> <arguments>` | Executes the [ChatOps](../ci/chatops/index.md) job `<job name>` on the default branch. |
2017-09-10 17:25:29 +05:30
2021-03-11 19:13:27 +05:30
If you are using the [GitLab Slack application](../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).
2018-03-17 18:26:18 +05:30
2017-09-10 17:25:29 +05:30
## Issue commands
2021-11-11 11:23:49 +05:30
You can create a new issue, display issue details, and search up to 5 issues.
2017-09-10 17:25:29 +05:30
## Deploy command
2021-03-11 19:13:27 +05:30
To deploy to an environment, GitLab tries to find a deployment
2017-09-10 17:25:29 +05:30
manual action in the pipeline.
2021-03-11 19:13:27 +05:30
If there's only one action for a given environment, it is triggered.
2021-11-11 11:23:49 +05:30
If more than one action is defined, GitLab finds an action
name that equals the environment name to deploy to.
2017-09-10 17:25:29 +05:30
2021-11-11 11:23:49 +05:30
The command returns an error if no matching action is found.