git_config - Чтение и запись конфигурации Git
Новое в версии 2.1.
Обзор
- Модуль
git_configизменяет конфигурацию Git, вызывая «git config». Это необходимо, если вы не хотите использовать шаблон для всего файла конфигурации Git (например, если вам нужно изменить толькоuser.emailв /etc/.git/config). Решения, использующие команду, являются громоздкими или не работают корректно в режиме проверки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- git
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| list_all bool |
| Вывести все настройки (при необходимости, ограничив их заданным scope) |
| name | Имя настройки. Если значение не задано, оно будет считано из конфигурации, если оно установлено. | |
| repo | Путь к репозиторию Git для чтения и записи значений из конкретного репозитория. | |
| scope |
| Укажите область, значения из которой нужно прочитать/установить. Это необходимо при установке значений конфигурации. Если установлено значение local, необходимо также указать параметр repo. По умолчанию значение равно системному, только если не используется list_all=да. |
| value | При указании имени отдельной настройки, укажите значение, которому следует присвоить эту настройку. |
Примеры
# Set some settings in ~/.gitconfig
- git_config:
name: alias.ci
scope: global
value: commit
- git_config:
name: alias.st
scope: global
value: status
# 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=нет и value не установлено, строка, содержащая значение настройки в поле name Пример: vim |
| config_values словарь | успех | Когда list_all=да, словарь, содержащий пары ключ/значение нескольких настроек конфигурации Пример: {'core.editor': 'vim', 'color.ui': 'auto', 'alias.diffc': 'diff --cached', 'alias.remotev': 'remote -v'} |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- Matthew Gamble
- Marius Gedminas
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/git_config_module.html