github_release - Взаимодействие с релизами GitHub
Новое в версии 2.2.
Обзор
- Получение метаданных о релизах GitHub
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- github3.py >= 1.0.0a3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action обязательно |
| Действие для выполнения |
| body (добавлено в 2.4) | Описание выпуска при создании выпуска | |
| draft (добавлено в 2.4) |
нет | Устанавливает, является ли выпуск черновиком или нет. (булево) |
| name (добавлено в 2.4) | Имя выпуска при создании выпуска | |
| password (добавлено в 2.4) | Значение по умолчанию: None | Пароль учетной записи GitHub для пользователя |
| prerelease (добавлено в 2.4) |
нет | Устанавливает, является ли выпуск предварительной версией или нет. (булево) |
| repo обязательно | Значение по умолчанию: None | Название репозитория |
| tag (добавлено в 2.4) | Имя тега при создании выпуска. Требуется, когда action установлено в create_release. | |
| target (добавлено в 2.4) | Цель выпуска при создании выпуска | |
| token | Значение по умолчанию: None | Токен личного доступа GitHub для аутентификации |
| user обязательно | Значение по умолчанию: None | Учетная запись GitHub, которая владеет репозиторием |
Примеры
- name: Get latest release of testuseer/testrepo
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.
github_release:
user: testuser
password: secret123
repo: testrepo
action: latest_release
- name: Create a new release
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 |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/github_release_module.html
