community.general.git_config module – Read and write git configuration
Note
This module is part of the community.general collection (version 5.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.git_config
.
Synopsis
The
git_config
module changes git configuration by invoking ‘git config’. This is needed if you don’t want to use ansible.builtin.template for the entire git config file (e.g. because you need to change justuser.email
in /etc/.git/config). Solutions involving ansible.builtin.command are cumbersome or don’t work correctly in check mode.
Requirements
The below requirements are needed on the host that executes this module.
git
Parameters
Parameter |
Comments |
---|---|
Path to an adhoc git configuration file to be managed using the |
|
List all settings (optionally limited to a given scope). Choices:
|
|
The name of the setting. If no value is supplied, the value will be read from the config if it has been set. |
|
Path to a git repository for reading and writing values from a specific repo. |
|
Specify which scope to read/set values from. This is required when setting config values. If this is set to If this is set to It defaults to system only when not using list_all= Choices:
|
|
Indicates the setting should be set/unset. This parameter has higher precedence than value parameter: when state=absent and value is defined, value is discarded. Choices:
|
|
When specifying the name of a single setting, supply a value to set that setting to the given value. |
Examples
- 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: 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 }}'
- name: Read individual values from git config
community.general.git_config:
name: alias.ci
scope: global
- name: Scope system is also assumed when reading values, unless list_all=true
community.general.git_config:
name: alias.diffc
- name: Read all values from git config
community.general.git_config:
list_all: true
scope: global
- name: When list_all is yes and no scope is specified, you get configuration from all scopes
community.general.git_config:
list_all: true
- name: Specify a repository to include local settings
community.general.git_config:
list_all: true
repo: /path/to/repo.git
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
When list_all=false and value is not set, a string containing the value of the setting in name Returned: success Sample: |
|
When list_all=true, a dict containing key/value pairs of multiple configuration settings Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication