github_webhook – Управление веб-хуками GitHub
Новая версия 2.8.
Описание
- Создание и удаление веб-хуков GitHub
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- PyGithub >= 1.3.5
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| active boolean |
| Активен ли хук |
| content_type - |
| Тип носителя, используемый для сериализации полезных данных |
| events - | Список событий GitHub, для которых срабатывает хук. Список событий указан на https://developer.github.com/v3/activity/events/types/. Требуется, если state равен absent | |
| github_url - | Значение по умолчанию: "https://api.github.com" | Базовый URL API GitHub |
| insecure_ssl boolean |
| Флаг, указывающий, что GitHub должен пропустить проверку SSL при вызове хука. |
| password - | Пароль для аутентификации в GitHub | |
| repository - / обязательно | Полное имя репозитория, для которого настраивается хук псевдонимы: repo | |
| secret - | Общий секрет между GitHub и URL полезных данных. | |
| state - |
| Указывает, должен ли хук присутствовать или отсутствовать |
| token - | Токен для аутентификации в GitHub | |
| url - / обязательно | URL, на который будут передаваться полезные данные | |
| user - / обязательно | Пользователь для аутентификации в GitHub |
Примеры
- name: create a new webhook that triggers on push (password auth)
github_webhook:
repository: ansible/ansible
url: https://www.example.com/hooks/
events:
- push
user: "{{ github_user }}"
password: "{{ github_password }}"
- name: create a new webhook in a github enterprise installation with multiple event triggers (token auth)
github_webhook:
repository: myorg/myrepo
url: https://jenkins.example.com/ghprbhook/
content_type: json
secret: "{{ github_shared_secret }}"
insecure_ssl: True
events:
- issue_comment
- pull_request
user: "{{ github_user }}"
token: "{{ github_user_api_token }}"
github_url: https://github.example.com
- name: delete a webhook (password auth)
github_webhook:
repository: ansible/ansible
url: https://www.example.com/hooks/
state: absent
user: "{{ github_user }}"
password: "{{ github_password }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| hook_id целое число | при state = 'present' | Идентификатор хука GitHub, созданного/обновленного Пример: 6206 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/github_webhook_module.html
