community.general.github_webhook_info 模块 – 查询 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_info。

概要 

查询 GitHub Webhook 信息

要求 

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

PyGithub >= 1.3.5

参数 

参数	注释
github_url 字符串	GitHub API 的基本 URL 默认值： `"https://api.github.com"`
password 字符串	用于身份验证 GitHub 的密码
repository 别名：repo 字符串 / 必需	要为其配置 Hook 的仓库的全名
token 字符串	用于身份验证 GitHub 的令牌
user 字符串 / 必需	用于身份验证 GitHub 的用户

属性 

属性	支持	描述
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	处于差异模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: List hooks for a repository (password auth)
  community.general.github_webhook_info:
    repository: ansible/ansible
    user: "{{ github_user }}"
    password: "{{ github_password }}"
  register: ansible_webhooks

- name: List hooks for a repository on GitHub Enterprise (token auth)
  community.general.github_webhook_info:
    repository: myorg/myrepo
    user: "{{ github_user }}"
    token: "{{ github_user_api_token }}"
    github_url: https://github.example.com/api/v3/
  register: myrepo_webhooks

返回值 

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
hooks 列表 / 元素=字典	仓库中存在的 Hook 列表返回：始终返回示例： `[{"active": true, "content_type": "json", "events": ["issue_comment", "pull_request"], "has_shared_secret": true, "id": 6206, "insecure_ssl": "1", "last_response": {"code": 200, "message": "OK", "status": "active"}, "url": "https://jenkins.example.com/ghprbhook/"}]`

作者

Chris St. Pierre (@stpierre)