Модуль community.general.github_release — Взаимодействие с релизами GitHub

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.general.github_release.

Описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Получение метаданных о релизах GitHub

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.

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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/github_release_module.html