community.general.github_release 模块 – 与 GitHub Releases 交互

注意

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

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

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

要在剧本中使用它，请指定： community.general.github_release。

概要

  • 获取有关 GitHub Releases 的元数据

要求

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

  • github3.py >= 1.0.0a3

参数

参数

注释

action

字符串 / 必需

要执行的操作

选项

  • "latest_release"

  • "create_release"

body

字符串

创建发布时的发布描述

draft

布尔值

设置发布是否为草稿。(布尔值)

选项

  • false ← (默认)

  • true

name

字符串

创建发布时的发布名称

password

字符串

用户的 GitHub 帐户密码。与 token 互斥。

prerelease

布尔值

设置发布是否为预发布。(布尔值)

选项

  • false ← (默认)

  • true

repo

字符串 / 必需

仓库名称

tag

字符串

创建发布时的标签名称。使用 action=create_release 时必需。

target

字符串

创建发布时的发布目标

token

字符串

用于身份验证的 GitHub 个人访问令牌。与 password 互斥。

user

字符串 / 必需

拥有仓库的 GitHub 帐户

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

处于差异模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Get latest release of a public repository
  community.general.github_release:
    user: ansible
    repo: ansible
    action: latest_release

- name: Get latest release of testuseer/testrepo
  community.general.github_release:
    token: tokenabc1234567890
    user: testuser
    repo: testrepo
    action: latest_release

- name: Get latest release of test repo using username and password
  community.general.github_release:
    user: testuser
    password: secret123
    repo: testrepo
    action: latest_release

- name: Create a new release
  community.general.github_release:
    token: tokenabc1234567890
    user: testuser
    repo: testrepo
    action: create_release
    tag: test
    target: master
    name: My Release
    body: Some description

返回值

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

键

描述

tag

字符串

已创建/最新发布的版本。

返回：成功

示例： "1.1.0"

作者

  • Adrian Moisey (@adrianmoisey)