Модуль community.general.github_repo — управление репозиториями на GitHub

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Если `true`, заменяет текущие атрибуты `description` и `private` значениями по умолчанию. Параметр `true` устарел и перестанет поддерживаться для этого параметра, начиная с community.general 13.0.0. Тогда значением по умолчанию будет `false`. Варианты: `false` `true`
name строка / обязательный	Имя репозитория.
organization строка	Организация, которой принадлежит репозиторий. Если `state=present`, репозиторий создаётся в профиле текущего пользователя.
password строка	Пароль для аутентификации. Нужен только в том случае, если не используется `access_token`.
private логический	Должен ли репозиторий быть закрытым. По умолчанию используется `false`, если `force_defaults=true`, что является значением по умолчанию для этого модуля. При создании нового репозитория по умолчанию используется `false`, если `force_defaults=false`. Используется только если `state=present`. Варианты: `false` `true`
state строка	Должен ли репозиторий существовать. Варианты: `"absent"` `"present"` ← (по умолчанию)
username строка	Имя пользователя для аутентификации. Нужно только в том случае, если не используется `access_token`.

Атрибуты

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

Примечания

Примечание

Для Python 3 следует использовать PyGithub>=1.54.

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/github_repo_module.html