Модуль community.general.github_secrets — управление секретами репозитория или организации GitHub

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: community.general.github_secrets.

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

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление или удаление секретов в репозитории или организации GitHub.

Требования

Следующие требования должны быть выполнены на узле, который выполняет этот модуль.

pynacl

Параметры

Параметр	Комментарии
api_url string	Базовый URL API GitHub. По умолчанию: `"https://api.github.com"`
key string	Имя секрета.
organization псевдонимы: org, username string / обязательный	Имя пользователя GitHub или название организации.
repository псевдонимы: repo string	Название репозитория. Если параметр не указан, секрет будет управляться на уровне организации.
state string	Требуемое состояние секрета. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string / обязательный	Токен GitHub для аутентификации.
value string	Значение секрета. Обязательно, если `state=present`.
visibility string	Видимость секрета при настройке на уровне организации. Обязательно, если `state=present` и параметр `repository` не задан. Варианты: `"all"` `"private"` `"selected"`

Атрибуты

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

Примеры

- name: Add Github secret
  community.general.github_secrets:
    token: "{{ lookup('ansible.builtin.env', 'GITHUB_TOKEN') }}"
    repository: "ansible"
    organization: "ansible"
    key: "TEST_SECRET"
    value: "bob"
    state: "present"

- name: Delete Github secret
  community.general.github_secrets:
    token: "{{ lookup('ansible.builtin.env', 'GITHUB_TOKEN') }}"
    repository: "ansible"
    organization: "ansible"
    key: "TEST_SECRET"
    state: "absent"

Возвращаемые значения

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

Ключ	Описание
result dictionary	Результат работы модуля. Возвращается: всегда Пример: `{"msg": "OK (2 bytes)", "response": "Secret created", "status": 201}`

Авторы

Thomas Sjögren (@konstruktoid)

Ссылки на коллекцию

© 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_secrets_module.html