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

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: community.general.github_release.

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

Краткое описание

Получение метаданных о выпусках GitHub.

Требования

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

github3.py >= 1.0.0a3

Параметры

Параметр	Комментарии
action string / обязательный	Действие, которое необходимо выполнить. Варианты: `"latest_release"` `"create_release"`
body string	Описание выпуска при его создании.
draft boolean	Указывает, является ли выпуск черновиком (логическое значение). Варианты: `false` ← (по умолчанию) `true`
name string	Название выпуска при его создании.
password string	Пароль учетной записи GitHub пользователя. Несовместим с `token`.
prerelease boolean	Указывает, является ли выпуск предварительным (логическое значение). Варианты: `false` ← (по умолчанию) `true`
repo string / обязательный	Имя репозитория.
tag string	Имя тега при создании выпуска. Обязательно при использовании `action=create_release`.
target string	Целевой объект выпуска при его создании.
token string	Персональный токен доступа GitHub для аутентификации. Несовместим с `password`.
user string / обязательный	Учетная запись GitHub, которой принадлежит репозиторий.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `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 string	Версия созданного или последнего выпуска. Возвращается: при успешном выполнении Пример: `"1.1.0"`

Авторы

Adrian Moisey (@adrianmoisey)

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

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