community.general.github_app_access_token 查找 – 获取短期的 Github App 访问令牌

注意

此查找插件是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要满足进一步的要求才能使用此查找插件，请参阅 要求 以了解详情。

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

community.general 8.2.0 中的新功能

概要

  • 如果您使用 Github App，这将生成一个 Github 访问令牌，该令牌可与 git 命令一起使用。

要求

在执行此查找的本地控制器节点上需要满足以下要求。

关键字参数

这描述了查找的关键字参数。这些是以下示例中的值 key1=value1、key2=value2 等：lookup('community.general.github_app_access_token', key1=value1, key2=value2, ...) 和 query('community.general.github_app_access_token', key1=value1, key2=value2, ...)

参数

注释

app_id

字符串 / 必需

您的 GitHub App ID，您可以在设置页面中找到它。

installation_id

字符串 / 必需

包含您要访问的 git 存储库的安装 ID。

截至 2023-12-24，可以通过“设置”页面 > “集成” > “应用程序”找到。配置按钮中 URL 的最后一部分是安装 ID。

或者，您可以使用 PyGithub (https://github.com/PyGithub/PyGithub) 来获取您的安装 ID。

key_path

路径

您的私钥的路径。

必须指定 key_path 或 private_key。

private_key

字符串

在 community.general 10.0.0 中添加

PEM 文件格式的 GitHub App 私钥，以字符串形式表示。

必须指定 key_path 或 private_key。

token_expiry

整数

令牌应持续多长时间（以秒为单位）。

默认值： 600

示例

- name: Get access token to be used for git checkout with app_id=123456, installation_id=64209
  ansible.builtin.git:
    repo: >-
      https://x-access-token:{{ github_token }}@github.com/hidden_user/super-secret-repo.git
    dest: /srv/checkout
  vars:
    github_token: >-
      {{ lookup('community.general.github_app_access_token', key_path='/home/to_your/key',
                app_id='123456', installation_id='64209') }}

返回值

键

描述

返回值

列表 / 元素=字符串

包含您的 GitHub 访问令牌的单元素列表。

返回： 成功

作者

  • Poh Wei Sheng (@weisheng-p)

提示

每个条目类型的配置条目都具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。