Модуль community.general.github_repo – Управление вашими репозиториями на Github

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.github_repo.

Добавлена в community.general 2.2.0

Обзор
Требования
Параметры
Атрибуты
Примечания
Примеры
Значения возврата

Обзор

Управляет репозиториями Github с использованием библиотеки PyGithub.
Авторизация может быть выполнена с помощью access_token или с помощью username и password.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

PyGithub>=1.54

Параметры

Параметр	Комментарии
access_token строка	Параметр токена для аутентификации. Требуется только в случае, если не используется `username` и `password`.
api_url строка добавлено в community.general 3.5.0	URL для API GitHub, если используется не github.com, а собственный экземпляр. Значение по умолчанию: `"https://api.github.com"`
description строка	Описание репозитория. По умолчанию пустая строка, если `force_defaults=true`, что является значением по умолчанию в этом модуле. По умолчанию пустая строка, если `force_defaults=false` при создании нового репозитория. Используется только тогда, когда `state` равно `present`.
force_defaults логическое значение добавлено в community.general 4.1.0	Перезаписать текущие `description` и `private` атрибуты значениями по умолчанию, если установлено `true`, что в настоящее время является значением по умолчанию. Значение по умолчанию для этого параметра будет устаревшим в будущих версиях этой коллекции и, в конечном итоге, изменится на `false`. Варианты: `false` `true` ← (значение по умолчанию)
name строка / обязательно	Имя репозитория.
... (остальной текст переведён аналогично)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменений без модификации целевого объекта.
... (остальной текст переведён аналогично)

Примечания

Примечание

Для Python 3 следует использовать PyGithub>=1.54.
Для Python 3.5 следует использовать PyGithub==1.54. Дополнительная информация: https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020.
Для Python 2.7 следует использовать PyGithub==1.45. Дополнительная информация: https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019.

Примеры

- name: Create a Github repository
  community.general.github_repo:
    access_token: mytoken
    organization: MyOrganization
    name: myrepo
    description: "Just for fun"
    private: true
    state: present
    force_defaults: false
  register: result

- name: Delete the repository
  community.general.github_repo:
    username: octocat
    password: password
    organization: MyOrganization
    name: myrepo
    state: absent
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
repo словарь	Информация о репозитории в формате JSON. См. https://docs.github.com/en/rest/reference/repos#get-a-repository. Возвращено: успех и `state=present`

Авторы

Álvaro Torres Cogollo (@atorrescogollo)

Ссылки на сборку

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