github_webhook – Управление веб-хуками GitHub

Новая версия с 2.8.

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

Описание

Создание и удаление веб-хуков GitHub

Требования

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

PyGithub >= 1.3.5

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
active boolean	Варианты: нет да ←	Включен ли хук
content_type -	Варианты: form ← json	Тип носителя, используемый для сериализации полезной нагрузки
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 целое число	при состоянии 'присутствует'	Идентификатор хука GitHub, созданного/обновленного Пример: 6206

Статус

Этот модуль не гарантирует обратную совместимость. [предварительный просмотр]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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_module.html