Модуль community.general.github_webhook_info – получение сведений о вебхуках GitHub

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.github_webhook_info.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Получение сведений о вебхуках GitHub.

Требования

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

PyGithub >= 1.3.5

Параметры

Параметр	Комментарии
github_url string	Базовый URL API GitHub. По умолчанию: `"https://api.github.com"`
password string	Пароль для аутентификации в GitHub.
repository псевдонимы: repo string / обязательный	Полное имя репозитория, для которого настраивается хук.
token string	Токен для аутентификации в GitHub.
user string / обязательный	Пользователь, от имени которого выполняется аутентификация в GitHub.

Атрибуты

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

Примеры

- name: List hooks for a repository (password auth)
  community.general.github_webhook_info:
    repository: ansible/ansible
    user: "{{ github_user }}"
    password: "{{ github_password }}"
  register: ansible_webhooks

- name: List hooks for a repository on GitHub Enterprise (token auth)
  community.general.github_webhook_info:
    repository: myorg/myrepo
    user: "{{ github_user }}"
    token: "{{ github_user_api_token }}"
    github_url: https://github.example.com/api/v3/
  register: myrepo_webhooks

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

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

Ключ	Описание
hooks list / elements=dictionary	Список хуков, существующих в репозитории. Возвращается: всегда Пример: `[{"active": true, "content_type": "json", "events": ["issue_comment", "pull_request"], "has_shared_secret": true, "id": 6206, "insecure_ssl": "1", "last_response": {"code": 200, "message": "OK", "status": "active"}, "url": "https://jenkins.example.com/ghprbhook/"}]`

Ключ

Описание

hooks

list / elements=dictionary

Список хуков, существующих в репозитории.

Возвращается: всегда

Пример: [{"active": true, "content_type": "json", "events": ["issue_comment", "pull_request"], "has_shared_secret": true, "id": 6206, "insecure_ssl": "1", "last_response": {"code": 200, "message": "OK", "status": "active"}, "url": "https://jenkins.example.com/ghprbhook/"}]

Авторы

Chris St. Pierre (@stpierre)

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

© 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/github_webhook_info_module.html