Модуль community.general.git_config_info – Чтение конфигурации git

Примечание

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

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

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

Для использования в плейбуке укажите: community.general.git_config_info.

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

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

Описание

Модуль community.general.git_config_info считывает конфигурацию git, вызывая git config.

Требования

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

Параметры

Параметр	Комментарии
name строка	Имя параметра для чтения. Если не указано, все параметры будут возвращены как `config_values`.
path путь	Путь к репозиторию git или файлу для чтения значений из конкретного репозитория. Если `scope` равно `local`, этот параметр должен указывать на репозиторий для чтения. Если `scope` равно `file`, этот параметр должен указывать на конкретный файл конфигурации git для чтения. В противном случае `path` игнорируется, если задано.
scope строка	Укажите область для чтения значений. Если установлено `global`, используется глобальная конфигурация git. `path` игнорируется. Если установлено `system`, используется системная конфигурация git. `path` игнорируется. Если установлено `local`, `path` должно быть установлено на репозиторий для чтения. Если установлено `file`, `path` должно быть установлено на файл конфигурации для чтения. Варианты: `"global"` `"system"` ← (по умолчанию) `"local"` `"file"`

Атрибуты

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

Примеры

- name: Read a system wide config
  community.general.git_config_info:
    name: core.editor
  register: result

- name: Show value of core.editor
  ansible.builtin.debug:
    msg: "{{ result.config_value | default('(not set)', true) }}"

- name: Read a global config from ~/.gitconfig
  community.general.git_config_info:
    name: alias.remotev
    scope: global

- name: Read a project specific config
  community.general.git_config_info:
    name: color.ui
    scope: local
    path: /etc

- name: Read all global values
  community.general.git_config_info:
    scope: global

- name: Read all system wide values
  community.general.git_config_info:

- name: Read all values of a specific file
  community.general.git_config_info:
    scope: file
    path: /etc/gitconfig

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

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

Ключ	Описание
config_value строка	Когда `name` установлено, строка, содержащая значение параметра в name. Если `name` не установлено, пусто. Если ключ конфигурации, такой как `push.pushoption`, имеет более одной записи, возвращается только первая. Возвращается: успех, если `name` установлено Пример: `"vim"`
config_values словарь	Это словарь, сопоставляющий параметр конфигурации git с списком его значений. Когда `name` не установлено, возвращаются все параметры конфигурации. Когда `name` установлено, возвращается только параметр, указанный в `name`. Если этот параметр не установлен, ключ всё равно будет присутствовать, и его значение будет пустым списком. Возвращается: успех Пример: `{"alias.remotev": ["remote -v"], "color.ui": ["auto"], "core.editor": ["vim"], "push.pushoption": ["merge_request.create", "merge_request.draft"]}`

Ключ

Описание

config_value

строка

Когда name установлено, строка, содержащая значение параметра в name. Если name не установлено, пусто. Если ключ конфигурации, такой как push.pushoption, имеет более одной записи, возвращается только первая.

Возвращается: успех, если name установлено

Пример: "vim"

config_values

словарь

Это словарь, сопоставляющий параметр конфигурации git с списком его значений.

Когда name не установлено, возвращаются все параметры конфигурации.

Когда name установлено, возвращается только параметр, указанный в name. Если этот параметр не установлен, ключ всё равно будет присутствовать, и его значение будет пустым списком.

Возвращается: успех

Пример: {"alias.remotev": ["remote -v"], "color.ui": ["auto"], "core.editor": ["vim"], "push.pushoption": ["merge_request.create", "merge_request.draft"]}

Авторы

Guenther Grill (@guenhter)

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

© 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/git_config_info_module.html