Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
    • Статус

Описание

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

Требования (к хосту, на котором выполняется модуль)

  • git

Параметры

параметр обязателен значение по умолчанию выбор комментарии
list_all
нет
  • да
  • нет
Перечислить все настройки (при необходимости, ограниченные заданным scope)
name
нет
Имя настройки. Если значение не указано, значение будет считано из конфигурации, если оно было установлено.
repo
нет
Путь к репозиторию git для чтения и записи значений из определённого репозитория.
scope
нет
  • локальный
  • глобальный
  • системный
Указывает область, из которой следует считывать/устанавливать значения. Это необходимо при установке значений конфигурации. Если значение установлено на локальный, необходимо также указать параметр 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'}

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Для помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и внесении вклада, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API