community.general.github_repo 模块 – 在 Github 上管理您的仓库

注意

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

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

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

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

community.general 2.2.0 中的新增功能

概要 

使用 PyGithub 库管理 Github 仓库。
可以使用 access_token 或 username 和 password 进行身份验证。

要求 

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

PyGithub>=1.54

参数 

参数	注释
access_token 字符串	用于身份验证的令牌参数。仅在不使用 `username` 和 `password` 时才需要。
api_url 字符串 community.general 3.5.0 中新增	如果不使用 github.com 而是您自己的实例，则为 GitHub API 的 URL。默认值： `"https://api.github.com"`
description 字符串	仓库的描述。如果 `force_defaults=true`（此模块中的默认值），则默认为空。如果 `force_defaults=false`，则在创建新仓库时默认为空。仅当 `state` 为 `present` 时使用。
force_defaults 布尔值 community.general 4.1.0 中新增	如果设置为 `true`（当前为默认值），则使用默认值覆盖当前的 `description` 和 `private` 属性。此选项的默认值将在此集合的未来版本中弃用，并最终更改为 `false`。选项 `false` `true` ← (默认)
name 字符串 / 必需	仓库名称。
organization 字符串	仓库的组织。当 `state=present` 时，仓库将创建在当前用户配置文件中。
password 字符串	用于身份验证的密码。仅在不使用 `access_token` 时才需要。
private 布尔值	仓库是否应为私有。如果 `force_defaults=true`（此模块中的默认值），则默认为 `false`。如果 `force_defaults=false`，则在创建新仓库时默认为 `false`。仅当 `state=present` 时使用。选项 `false` `true`
state 字符串	仓库是否存在。选项 `"absent"` `"present"` ← (默认)
username 字符串	用于身份验证的用户名。仅在不使用 `access_token` 时才需要。

属性 

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

备注 

注意

对于 Python 3，应使用 PyGithub>=1.54。
对于 Python 3.5，应使用 PyGithub==1.54。更多信息：https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020。
对于 Python 2.7，应使用 PyGithub==1.45。更多信息：https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019。

示例 

- name: Create a Github repository
  community.general.github_repo:
    access_token: mytoken
    organization: MyOrganization
    name: myrepo
    description: "Just for fun"
    private: true
    state: present
    force_defaults: false
  register: result

- name: Delete the repository
  community.general.github_repo:
    username: octocat
    password: password
    organization: MyOrganization
    name: myrepo
    state: absent
  register: result

返回值 

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

键	描述
repo 字典	作为 JSON 的仓库信息。参见 https://docs.github.com/en/rest/reference/repos#get-a-repository。返回值：成功且`state=present`

作者

Álvaro Torres Cogollo (@atorrescogollo)