gitlab_hook – Управление хуками проекта GitLab
Новое в версии 2.6.
Описание
- Добавляет, обновляет и удаляет хуки проекта.
Псевдонимы: gitlab_hooks
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- модуль python-gitlab python <= 1.12.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль для аутентификации с API. | |
| api_token строка добавлен в 2.8 | Токен GitLab для входа. псевдонимы: private_token, access_token | |
| api_url строка | Доступный конечный пункт API. | |
| api_username строка | Имя пользователя для аутентификации с API. | |
| hook_url строка / обязательно | URL, который GitLab должен отправлять. Используется в качестве первичного ключа для обновлений и удаления. | |
| hook_validate_certs логическое |
| Выполнять ли GitLab проверку SSL при запуске хука. псевдонимы: enable_ssl_verification |
| issues_events логическое |
| Вызвать хук при событиях проблем. |
| job_events логическое |
| Вызвать хук при событиях задач. |
| merge_requests_events логическое |
| Вызвать хук при событиях запросов слияния. |
| note_events логическое |
| Вызвать хук при событиях заметок. |
| pipeline_events логическое |
| Вызвать хук при событиях конвейера. |
| project строка / обязательно | Идентификатор или полный путь к проекту в формате группа/название. | |
| push_events логическое |
| Вызвать хук при событиях push. |
| state строка / обязательно |
| При значении present хук будет обновлен в соответствии с входными данными или создан, если он не существует. При значении absent он будет удален, если существует. |
| tag_push_events логическое |
| Вызвать хук при событиях push тегов. |
| token строка | Секретный токен для проверки сообщений хука на стороне получателя. Если присутствует, всегда приведет к изменению, так как его нельзя получить из GitLab. Будет отображаться в заголовке HTTP-запроса X-Gitlab-Token | |
| validate_certs логическое |
| Выполнять ли проверку SSL-сертификатов при указании https-адреса. |
| wiki_page_events логическое |
| Вызвать хук при событиях вики. |
Примеры
- name: "Adding a project hook"
gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: present
push_events: yes
tag_push_events: yes
hook_validate_certs: no
token: "my-super-secret-token-that-my-ci-server-will-check"
- name: "Delete the previous hook"
gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
- name: "Delete a hook by numeric project id"
gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: 10
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| error строка | failed | Сообщение об ошибке, возвращенное API GitLab. Пример: 400: путь уже используется |
| hook словарь | всегда | Объект API |
| msg строка | всегда | Сообщение об успехе или об ошибке. Пример: Успешно |
| result словарь | всегда | Обработанный JSON-ответ от сервера. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Marcus Watkins (@marwatk)
- Guillaume Martinez (@Lunik)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gitlab_hook_module.html
