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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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/)

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `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

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

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

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

Авторы

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

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

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