github_webhook_facts – Запрос информации о веб-хуках GitHub
Новое в версии 2.8.
Обзор
- Запрос информации о веб-хуках GitHub
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- 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)
github_webhook_facts:
repository: ansible/ansible
user: "{{ github_user }}"
password: "{{ github_password }}"
register: ansible_webhooks
- name: list hooks for a repository on GitHub Enterprise (token auth)
github_webhook_facts:
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": "active", "message": "OK", "code": 200}}] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный просмотр]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Chris St. Pierre (@stpierre)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/github_webhook_facts_module.html