Модуль community.general.git_config — обновление конфигурации git

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.git_config.

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

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

Требования

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

Параметры

Параметр	Комментарии
add_mode строка добавлено в community.general 8.1.0	Указывает, должно ли значение заменить существующие значения или новое значение должно быть добавлено наряду с другими значениями с тем же именем. Этот параметр применяется только при добавлении или замене значений. Если `state=absent` или значения только считываются, этот параметр не учитывается. Варианты: `"add"` `"replace-all"` ← (по умолчанию)
file путь добавлено в community.general 2.0.0	Путь к специальному файлу конфигурации git, управляемому с использованием области `file`.
name строка / обязательный	Имя параметра.
repo путь	Путь к репозиторию git, значения которого нужно прочитать или записать.
scope строка	Указывает область, из которой нужно считывать или в которую нужно задавать значения. Этот параметр обязателен при задании значений конфигурации. Если задано значение `local`, необходимо также указать параметр `repo`. Если задано значение `file`, необходимо также указать параметр `file`. По умолчанию используется system. Варианты: `"file"` `"local"` `"global"` `"system"`
state строка	Указывает, следует ли задать или отменить значение параметра. Этот параметр имеет более высокий приоритет, чем параметр `value`: если заданы `state=absent` и `value`, параметр `value` игнорируется. Варианты: `"present"` ← (по умолчанию) `"absent"`
value строка	При указании имени одного параметра задайте значение, которое будет присвоено этому параметру. Начиная с community.general 11.0.0, параметр `value` обязателен, если `state=present`. Для чтения значений используйте модуль community.general.git_config_info.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогнозируемый статус изменения, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или об изменениях, которые, возможно, необходимо внести в `check_mode`).

Примеры

- name: Add a setting to ~/.gitconfig
  community.general.git_config:
    name: alias.ci
    scope: global
    value: commit

- name: Add a setting to ~/.gitconfig
  community.general.git_config:
    name: alias.st
    scope: global
    value: status

- name: Remove a setting from ~/.gitconfig
  community.general.git_config:
    name: alias.ci
    scope: global
    state: absent

- name: Add a setting to ~/.gitconfig
  community.general.git_config:
    name: core.editor
    scope: global
    value: vim

- name: Add a setting system-wide
  community.general.git_config:
    name: alias.remotev
    scope: system
    value: remote -v

- name: Add a setting to a system scope (default)
  community.general.git_config:
    name: alias.diffc
    value: diff --cached

- name: Add a setting to a system scope (default)
  community.general.git_config:
    name: color.ui
    value: auto

- name: Add several options for the same name
  community.general.git_config:
    name: push.pushoption
    value: "{{ item }}"
    add_mode: add
  loop:
    - merge_request.create
    - merge_request.draft

- name: Make etckeeper not complaining when it is invoked by cron
  community.general.git_config:
    name: user.email
    repo: /etc
    scope: local
    value: 'root@{{ ansible_fqdn }}'

Авторы

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

Ссылки на коллекцию

© 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_module.html