Модуль community.general.github_webhook — Управление веб-хуками GitHub

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: community.general.github_webhook.

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

Описание

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

Требования

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

PyGithub >= 1.3.5

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз о произошедших изменениях без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Возвратит детали изменений (или, возможно, требующих изменения в `check_mode`), когда используется режим diff.

Примеры

- 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 целое число	Идентификатор GitHub хука, созданного/обновлённого Возвращается: при состоянии ‘present’ Пример: `6206`

Авторы

Chris St. Pierre (@stpierre)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/github_webhook_module.html