community.general.github_webhook_info – Запрос информации о GitHub-вебхуках

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.github_webhook_info.

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

Описание

Запрос информации о GitHub-вебхуках
Этот модуль назывался github_webhook_facts до Ansible 2.9. Использование не изменилось.

Требования

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

PyGithub >= 1.3.5

Параметры

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

Примеры

- 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 список / элементы=строка	всегда	Список вебхуков, существующих для репозитория Пример: [{"has_shared_secret": true, "url": "https://jenkins.example.com/ghprbhook/", "events": ["issue_comment", "pull_request"], "insecure_ssl": "1", "content_type": "json", "active": true, "id": 6206, "last_response": {"status": "активно", "message": "OK", "code": 200}}]

Авторы

Chris St. Pierre (@stpierre)

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