community.general.github_release – Взаимодействие с релизами GitHub
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.github_release.
Обзор
- Получение метаданных о релизах GitHub
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- github3.py >= 1.0.0a3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка / обязательно |
| Действие для выполнения |
| body строка | Описание релиза при создании релиза | |
| draft логическое значение |
| Устанавливает, является ли релиз черновиком или нет. (логическое значение) |
| name строка | Имя релиза при создании релиза | |
| password строка | Пароль учетной записи GitHub для пользователя. Взаимоисключающий с token. | |
| prerelease логическое значение |
| Устанавливает, является ли релиз предварительной версией или нет. (логическое значение) |
| repo строка / обязательно | Имя репозитория | |
| tag строка | Имя тега при создании релиза. Требуется, когда действие установлено на create_release. | |
| target строка | Цель релиза при создании релиза | |
| token строка | Личный токен доступа GitHub для аутентификации. Взаимоисключающий с password. | |
| user строка / обязательно | Учетная запись GitHub, владеющая репозиторием |
Примеры
- 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. Ansible 2.4.
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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| create_release строка | success | Версия созданного релиза Для Ansible версии 2.5 и выше, если указанная версия релиза уже существует, то состояние остается неизменным Для версий Ansible, предшествующих 2.5, если указанная версия релиза уже существует, то состояние пропускается Пример: 1.1.0 |
| latest_release строка | success | Версия последнего релиза Пример: 1.1.0 |
Авторы
- Adrian Moisey (@adrianmoisey)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/github_release_module.html
