community.general.github_webhook 模块 – 管理 GitHub Webhook

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.general.github_webhook。

概要 

创建和删除 GitHub Webhook

要求 

执行此模块的主机需要以下要求。

PyGithub >= 1.3.5

参数 

参数	注释
active 布尔值	Webhook 是否处于活动状态选项 `false` `true` ← (默认)
content_type 字符串	用于序列化有效负载的媒体类型选项 `"form"` ← (默认) `"json"`
events 列表 / 元素=字符串	Webhook 触发的 GitHub 事件列表。事件列在 https://developer.github.com/v3/activity/events/types/。除非 `state=absent`，否则为必填项。
github_url 字符串	GitHub API 的基本 URL 默认值： `"https://api.github.com"`
insecure_ssl 布尔值	标志，指示 GitHub 在调用 Hook 时是否应跳过 SSL 验证。选项 `false` ← (默认) `true`
password 字符串	用于对 GitHub 进行身份验证的密码
repository 别名：repo 字符串 / 必填	要为其配置 Hook 的存储库的完整名称
secret 字符串	GitHub 和有效负载 URL 之间的共享密钥。
state 字符串	Hook 是否应该存在或不存在选项 `"absent"` `"present"` ← (默认)
token 字符串	用于对 GitHub 进行身份验证的令牌
url 字符串 / 必填	将交付有效负载的 URL
user 字符串 / 必填	用于对 GitHub 进行身份验证的用户

属性 

属性	支持	描述
check_mode	支持：不支持	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要更改的内容，在 `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 整数	已创建/更新的 Hook 的 GitHub ID 返回：当 state 为 ‘present’ 时示例： `6206`

作者

Chris St. Pierre (@stpierre)