git_config - Чтение и запись конфигурации git
Новая версия с 2.1.
Описание
- Модуль
git_configизменяет конфигурацию git, вызывая ‘git config’. Это необходимо, если вы не хотите использовать шаблон для всего файла конфигурации git (например, потому что вам нужно изменить толькоuser.emailв /etc/.git/config). Решения, использующие команду, громоздки или не работают корректно в режиме проверки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- git
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| list_all |
| Перечислить все настройки (при необходимости, ограниченные заданным scope) |
| name | Значение по умолчанию: None | Имя настройки. Если значение не указано, оно будет считано из конфигурации, если задано. |
| repo | Значение по умолчанию: None | Путь к репозиторию git для чтения и записи значений из конкретного репозитория. |
| scope |
None | Укажите область, из которой необходимо считать/задать значения. Это необходимо при задании значений конфигурации. Если установлено значение local, вы также должны указать параметр repo. По умолчанию используется system, только если list_all=yes. |
| value | Значение по умолчанию: None | При указании имени отдельной настройки, укажите значение, чтобы установить настройку на это значение. |
Примеры
# 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=no и значение не установлено, строка, содержащая значение настройки в параметре name Пример: vim |
| config_values словарь | успех | Когда list_all=yes, словарь, содержащий пары ключ/значение для нескольких настроек конфигурации Пример: {'core.editor': 'vim', 'color.ui': 'auto', 'alias.diffc': 'diff --cached', 'alias.remotev': 'remote -v'} |
Статус
Этот модуль помечен как предварительная версия, что означает, что гарантии обратной совместимости нет.
Автор
- 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.5/modules/git_config_module.html