community.general.gitlab_hook модуль — Управляет хуками проектов GitLab

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: community.general.gitlab_hook.

Обзор
Требования
Параметры
Атрибуты
Примеры
Значения возврата

Обзор

Добавляет, обновляет и удаляет хуки проекта

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python-gitlab модуль Python
requests (библиотека Python https://pypi.org/project/requests/)

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_job_token string added in community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token string added in community.general 4.2.0	Токен GitLab OAuth для входа.
api_password string	Пароль для аутентификации в API.
api_token string	Токен доступа GitLab с правами API.
api_url string	Разрешаемая конечная точка для API.
api_username string	Имя пользователя для аутентификации в API.
ca_path string added in community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
hook_url string / required	URL, на который GitLab должен отправлять сообщения; используется в качестве первичного ключа для обновления и удаления.
hook_validate_certs aliases: enable_ssl_verification boolean	Будет ли GitLab выполнять проверку SSL при срабатывании хука. Варианты: `false` ← (default) `true`
issues_events boolean	Срабатывание хука на события, связанные с задачами. Варианты: `false` ← (default) `true`
job_events boolean	Срабатывание хука на события, связанные с заданиями. Варианты: `false` ← (default) `true`
merge_requests_events boolean	Срабатывание хука на события, связанные с запросами на слияние. Варианты: `false` ← (default) `true`
note_events boolean	Срабатывание хука на события, связанные с заметками, или когда кто-то добавляет комментарий. Варианты: `false` ← (default) `true`
pipeline_events boolean	Срабатывание хука на события, связанные с конвейерами. Варианты: `false` ← (default) `true`
project string / required	ID или полный путь проекта в формате group/name.
push_events boolean	Срабатывание хука на события push. Варианты: `false` `true` ← (default)
push_events_branch_filter string added in community.general 0.2.0	Имя ветки или шаблон с подстановочными знаками для срабатывания хука на события push По умолчанию: `""`
releases_events boolean added in community.general 8.4.0	Срабатывание хука на события, связанные с релизами. Варианты: `false` `true`
state string	Когда `present` хук будет обновлен в соответствии с входными данными или создан, если он не существует. Когда `absent` хук будет удален, если он существует. Варианты: `"present"` ← (default) `"absent"`
tag_push_events boolean	Срабатывание хука на события push тегов. Варианты: `false` ← (default) `true`

ключ строка	Секретный ключ для проверки сообщений хуков на стороне получателя. Если этот ключ присутствует, это всегда приведет к изменению, так как его нельзя получить из GitLab. Будет отображаться в заголовке HTTP-запроса X-GitLab-Token.
validate_certs логическое	Включает или отключает проверку SSL-сертификатов при использовании HTTPS-подключения. Варианты: `false` `true` ← (по умолчанию)
wiki_page_events логическое	Вызвать хук при событиях на страницах вики. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме проверки и возвращать прогноз о изменениях, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения вернет подробности о изменениях (или, возможно, необходимости изменений в `check_mode`).

Примеры

- 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: true
    tag_push_events: true
    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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
ошибка строка	сообщение об ошибке, возвращаемое API GitLab Возвращается: при ошибке Пример: `"400: path is already in use"`
хук словарь	объект API Возвращается: всегда
сообщение строка	Сообщение об успехе или ошибке Возвращается: всегда Пример: `"Success"`
результат словарь	разбор JSON ответа сервера Возвращается: всегда

Авторы

Marcus Watkins (@marwatk)
Guillaume Martinez (@Lunik)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_hook_module.html