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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Имя параметра, значение которого нужно прочитать. Если значение не указано, все параметры возвращаются как `config_values`.
path path	Путь к репозиторию git или файлу для чтения значений из определённого репозитория. Если `scope` равно `local`, здесь должен быть указан репозиторий, из которого нужно читать данные. Если `scope` равно `file`, здесь должен быть указан файл конфигурации git, из которого нужно читать данные. В противном случае `path` игнорируется, если задан.
scope string	Укажите область, из которой нужно читать значения. Если задано значение `global`, используется глобальная конфигурация git. `path` игнорируется. Если задано значение `system`, используется системная конфигурация git. `path` игнорируется. Если задано значение `local`, параметру `path` необходимо указать репозиторий, из которого нужно читать данные. Если задано значение `file`, параметру `path` необходимо указать файл конфигурации, из которого нужно читать данные. Варианты: `"global"` `"system"` ← (по умолчанию) `"local"` `"file"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Можно выполнять в `check_mode` и возвращать прогноз изменения статуса без изменения целевого узла.
diff_mode	Поддержка: N/A Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `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 string	Если задан `name`, строка со значением параметра, указанного в name. Если `name` не задан, возвращается пустая строка. Если ключ конфигурации, например `push.pushoption`, имеет несколько значений, здесь возвращается только первое. Возвращается: при успехе, если задан `name` Пример: `"vim"`
config_values dictionary	Словарь, сопоставляющий параметр конфигурации git со списком его значений. Если `name` не задан, здесь возвращаются все параметры конфигурации. Если задан `name`, здесь возвращается только параметр, указанный в `name`. Если этот параметр не задан, ключ всё равно присутствует, а его значением является пустой список. Возвращается: при успехе Пример: `{"alias.remotev": ["remote -v"], "color.ui": ["auto"], "core.editor": ["vim"], "push.pushoption": ["merge_request.create", "merge_request.draft"]}`

Ключ

Описание

config_value

string

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

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

Пример: "vim"

config_values

dictionary

Словарь, сопоставляющий параметр конфигурации 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/git_config_info_module.html