github_release - Взаимодействие с релизами GitHub
Новое в версии 2.2.
Описание
- Получение метаданных о релизах GitHub
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- github3.py >= 1.0.0a3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action обязательно |
| Действие для выполнения |
| body (добавлен в 2.4) | Описание релиза при создании релиза | |
| draft bool (добавлен в 2.4) |
| Устанавливает, является ли релиз черновиком или нет. (логическое значение) |
| name (добавлен в 2.4) | Имя релиза при создании релиза | |
| password (добавлен в 2.4) | Пароль учетной записи GitHub для пользователя | |
| prerelease bool (добавлен в 2.4) |
| Устанавливает, является ли релиз предварительным или нет. (логическое значение) |
| repo обязательно | Имя репозитория | |
| tag (добавлен в 2.4) | Имя тега при создании релиза. Требуется, когда действие установлено в create_release. | |
| target (добавлен в 2.4) | Целевой объект релиза при создании релиза | |
| token | Токен GitHub Personal Access для аутентификации | |
| user обязательно | Учетная запись 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/github_release_module.html
