diff options
Diffstat (limited to 'doc/ci/chatops/index.md')
| -rw-r--r-- | doc/ci/chatops/index.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ci/chatops/index.md b/doc/ci/chatops/index.md index 5f661731660..03a1005c9bc 100644 --- a/doc/ci/chatops/index.md +++ b/doc/ci/chatops/index.md @@ -25,23 +25,23 @@ with the following arguments: - A `<job name>` to execute. - The `<job arguments>`. -ChatOps passes the following [CI/CD variables](../variables/README.md#predefined-cicd-variables) +ChatOps passes the following [CI/CD variables](../variables/index.md#predefined-cicd-variables) to the job: - `CHAT_INPUT` contains any additional arguments. - `CHAT_CHANNEL` is set to the name of channel the action was triggered in. When executed, ChatOps looks up the specified job name and attempts to match it -to a corresponding job in [`.gitlab-ci.yml`](../yaml/README.md). If a matching job -is found on `master`, a pipeline containing only that job is scheduled. After the +to a corresponding job in [`.gitlab-ci.yml`](../yaml/index.md). If a matching job +is found on the default branch, a pipeline containing only that job is scheduled. After the job completes: - If the job completes in *less than 30 minutes*, the ChatOps sends the job's output to Slack. - If the job completes in *more than 30 minutes*, the job must use the [Slack API](https://api.slack.com/) to send data to the channel. -To use the `run` command, you must have -[Developer access or above](../../user/permissions.md#project-members-permissions). +To use the `run` command, you must have at least the +[Developer role](../../user/permissions.md#project-members-permissions). If a job shouldn't be able to be triggered from chat, you can set the job to `except: [chat]`. ## Best practices for ChatOps CI jobs @@ -53,11 +53,11 @@ functions available. Consider these best practices when creating ChatOps jobs: of the standard CI pipeline. - If the job is set to `when: manual`, ChatOps creates the pipeline, but the job waits to be started. - ChatOps provides limited support for access control. If the user triggering the - slash command has [Developer access or above](../../user/permissions.md#project-members-permissions) + slash command has at least the [Developer role](../../user/permissions.md#project-members-permissions) in the project, the job runs. The job itself can use existing - [CI/CD variables](../variables/README.md#predefined-cicd-variables) like + [CI/CD variables](../variables/index.md#predefined-cicd-variables) like `GITLAB_USER_ID` to perform additional rights validation, but - these variables can be [overridden](../variables/README.md#cicd-variable-precedence). + these variables can be [overridden](../variables/index.md#cicd-variable-precedence). ### Controlling the ChatOps reply |