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

48 lines
2.5 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2021-02-22 17:27:13 +05:30
stage: Create
group: Ecosystem
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-04-17 20:07:23 +05:30
# Slash Commands **(FREE)**
2017-09-10 17:25:29 +05:30
2021-03-11 19:13:27 +05:30
> - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24780) to GitLab Free in 11.9.
2019-07-07 11:18:12 +05:30
2021-03-11 19:13:27 +05:30
Slash commands in Mattermost and Slack allow you to control GitLab and view GitLab content right inside your chat client, without having to leave it. For Slack, this requires an [integration configuration](../user/project/integrations/slack_slash_commands.md). Type the command as a message in your chat client to activate it.
2017-09-10 17:25:29 +05:30
Commands are scoped to a project, with a trigger term that is specified during configuration.
We suggest you use the project name as the trigger term for simplicity and clarity.
Taking the trigger term as `project-name`, the commands are:
| Command | Effect |
| ------- | ------ |
| `/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>` |
2020-05-24 23:13:21 +05:30
| `/project-name issue show <id>` | Shows the issue with ID `<id>` |
| `/project-name issue close <id>` | Closes the issue with ID `<id>` |
2017-09-10 17:25:29 +05:30
| `/project-name issue search <query>` | Shows up to 5 issues matching `<query>` |
2018-05-09 12:01:36 +05:30
| `/project-name issue move <id> to <project>` | Moves issue ID `<id>` to `<project>` |
2020-05-24 23:13:21 +05:30
| `/project-name issue comment <id> <shift+return> <comment>` | Adds a new comment to an issue with ID `<id>` and comment body `<comment>` |
2017-09-10 17:25:29 +05:30
| `/project-name deploy <from> to <to>` | Deploy from the `<from>` environment to the `<to>` environment |
2021-03-11 19:13:27 +05:30
| `/project-name run <job name> <arguments>` | Execute [ChatOps](../ci/chatops/index.md) job `<job name>` on `master` |
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-03-11 19:13:27 +05:30
It's possible to create 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.
If more than one action is defined, GitLab tries to find an action
2017-09-10 17:25:29 +05:30
which name equals the environment name we want to deploy to.
2021-02-22 17:27:13 +05:30
The command returns an error when no matching action has been found.