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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.general.github_webhook.

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

Обзор

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

Требования

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

PyGithub >= 1.3.5

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
active boolean	Варианты: нет да ←	Активен ли хук
content_type string	Варианты: form ← json	Тип носителя, используемый для сериализации полезной нагрузки
events list / elements=string		Список событий GitHub, для которых срабатывает хук. Список событий см. на https://developer.github.com/v3/activity/events/types/. Требуется, если `state` не `absent`.
github_url string	Значение по умолчанию: "https://api.github.com"	Базовый URL API GitHub
insecure_ssl boolean	Варианты: нет ← да	Флаг, указывающий, что GitHub должен пропустить проверку SSL при вызове хука.
password string		Пароль для аутентификации в GitHub
repository string / required		Полное имя репозитория, для которого нужно настроить хук алиасы: repo
secret string		Секретный ключ для обмена между GitHub и URL полезной нагрузки.
state string	Варианты: отсутствует присутствует ←	Наличие или отсутствие хука
token string		Токен для аутентификации в GitHub
url string / required		URL, на который будут передаваться полезные нагрузки
user string / required		Пользователь для аутентификации в GitHub

Примеры

- name:  create a new webhook that triggers on push (password auth)
  community.general.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)
  community.general.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)
  community.general.github_webhook:
    repository: ansible/ansible
    url: https://www.example.com/hooks/
    state: absent
    user: "{{ github_user }}"
    password: "{{ github_password }}"

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
hook_id integer	при state = 'present'	ID хука в GitHub, созданного/обновленного Пример: 6206

Авторы

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