github_release – Взаимодействие с выпусками GitHub
Обзор
- Получение метаданных о выпусках GitHub
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- github3.py >= 1.0.0a3
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action - / обязательно |
| Действие для выполнения |
| body - добавлено в 2.4 | Описание выпуска при создании выпуска | |
| draft логическое добавлено в 2.4 |
| Устанавливает, является ли выпуск черновиком или нет. (логическое значение) |
| name - добавлено в 2.4 | Имя выпуска при создании выпуска | |
| password - добавлено в 2.4 | Пароль учетной записи GitHub для пользователя. Взаимоисключающее с token. | |
| prerelease логическое добавлено в 2.4 |
| Устанавливает, является ли выпуск предварительным или нет. (логическое значение) |
| repo - / обязательно | Название репозитория | |
| tag - добавлено в 2.4 | Имя тега при создании выпуска. Требуется, когда действие установлено в create_release. | |
| target - добавлено в 2.4 | Цель выпуска при создании выпуска | |
| token - | Токен GitHub Personal Access для аутентификации. Взаимоисключающее с password. | |
| user - / обязательно | Учетная запись GitHub, владеющая репозиторием |
Примеры
- name: Get latest release of a public repository
github_release:
user: ansible
repo: ansible
action: latest_release
- 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. [сообщество]
Авторы
- 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.9/modules/github_release_module.html
