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 логическое |
| Выполнять ли проверку SSL GitLab при запуске хука. Псевдонимы: enable_ssl_verification |
| issues_events логическое |
| Вызывать хук при событиях задач. |
| job_events логическое |
| Вызывать хук при событиях задач. |
| merge_requests_events логическое |
| Вызывать хук при событиях запросов на слияние. |
| note_events логическое |
| Вызывать хук при событиях заметок или комментариев. |
| pipeline_events логическое |
| Вызывать хук при событиях конвейера. |
| project строка / обязательно | ID или полное имя проекта в формате группа/имя. | |
| 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. [сообщество]
Авторы
- 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.9/modules/gitlab_hook_module.html
