community.general.gitlab_hook – Управляет хуками проекта GitLab.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.gitlab_hook.
Обзор
- Добавляет, обновляет и удаляет хук проекта.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- модуль python-gitlab
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль для аутентификации по API | |
| api_token строка | Токен GitLab для входа. | |
| 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. |
| push_events_branch_filter строка добавлено в 0.2.0 community.general | Имя ветки или шаблон для запуска хука при событиях 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"
community.general.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"
community.general.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"
community.general.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-ответ от сервера |
Авторы
- Marcus Watkins (@marwatk)
- Guillaume Martinez (@Lunik)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gitlab_hook_module.html
