Модуль community.general.github_webhook_info — Запрос информации о GitHub вебхуках

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка	Базовый URL API GitHub По умолчанию: `"https://api.github.com"`
password строка	Пароль для аутентификации в GitHub
repository псевдонимы: repo строка / обязательно	Полное имя репозитория для настройки хука
token строка	Токен для аутентификации в GitHub
user строка / обязательно	Пользователь для аутентификации в GitHub

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в `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 список / элементы=словарь	Список хуков, существующих для репозитория Возвращается: всегда Пример: `[{"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

список / элементы=словарь

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

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

Пример: [{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/github_webhook_info_module.html