git_config – Чтение и запись конфигурации git

Новое в версии 2.1.

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

Обзор

Модуль git_config изменяет конфигурацию git, вызывая ‘git config’. Это необходимо, если вы не хотите использовать шаблон для всего файла конфигурации git (например, потому что вам нужно изменить только user.email в /etc/.git/config). Решения, использующие команду, неудобны или не работают правильно в режиме проверки.

Требования

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
list_all boolean	Варианты: no ← да	Вывести все настройки (при необходимости ограниченные заданным scope)
name -		Имя настройки. Если значение не указано, оно будет считано из конфигурации, если оно установлено.
repo -		Путь к репозиторию git для чтения и записи значений из определенного репозитория.
scope -	Варианты: локальный глобальный системный	Укажите область, из которой нужно читать/задавать значения. Это обязательно при задании значений конфигурации. Если установлено значение локальный, необходимо также указать параметр repo. По умолчанию используется системный, только если list_all=да.
state - добавлен в 2.8	Варианты: present ← absent	Указывает, что настройка должна быть установлена/удалена. Этот параметр имеет более высокий приоритет, чем параметр value: когда state=absent и value определён, value игнорируется.
value -		При указании имени одной настройки, укажите значение для задания этой настройки.

Примеры

# Set some settings in ~/.gitconfig
- git_config:
    name: alias.ci
    scope: global
    value: commit

- git_config:
    name: alias.st
    scope: global
    value: status

# Unset some settings in ~/.gitconfig
- git_config:
    name: alias.ci
    scope: global
    state: absent

# Or system-wide:
- git_config:
    name: alias.remotev
    scope: system
    value: remote -v

- git_config:
    name: core.editor
    scope: global
    value: vim

# scope=system is the default
- git_config:
    name: alias.diffc
    value: diff --cached

- git_config:
    name: color.ui
    value: auto

# Make etckeeper not complain when invoked by cron
- git_config:
    name: user.email
    repo: /etc
    scope: local
    value: 'root@{{ ansible_fqdn }}'

# Read individual values from git config
- git_config:
    name: alias.ci
    scope: global

# scope: system is also assumed when reading values, unless list_all=yes
- git_config:
    name: alias.diffc

# Read all values from git config
- git_config:
    list_all: yes
    scope: global

# When list_all=yes and no scope is specified, you get configuration from all scopes
- git_config:
    list_all: yes

# Specify a repository to include local settings
- git_config:
    list_all: yes
    repo: /path/to/repo.git

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

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

Ключ	Возвращаемое значение	Описание
config_value строка	успех	Когда list_all=no и значение не задано, строка, содержащая значение настройки в name. Пример: vim
config_values словарь	успех	Когда list_all=yes, словарь, содержащий пары ключ/значение нескольких настроек конфигурации Пример: {'core.editor': 'vim', 'color.ui': 'auto', 'alias.diffc': 'diff --cached', 'alias.remotev': 'remote -v'}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Matthew Gamble (@djmattyg007)
Marius Gedminas (@mgedmin)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/git_config_module.html