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

Примечание

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

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

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

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

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

Краткое описание

Создание и удаление веб-перехватчиков GitHub.

Требования

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

PyGithub >= 1.3.5

Параметры

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

Атрибуты

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

Примеры

- 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, созданного или обновлённого модулем. Возвращается: если state имеет значение ‘present’ Пример: `6206`

Авторы

Chris St. Pierre (@stpierre)

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

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