CODEWITHSUNDEEP
gitgit-config
Mark Nichols
Mark Nichols

Reputation: 1503

Can gitconfig options be set conditionally?

Via Github I use the same set of "dot files" on several different computers and servers. On the Macs and Linux boxes under my direct control I have Sublime Text 2 installed and set up as my git merge and commit editor of choice. However, on remote (i.e., not under my direct control) servers I would select to use vim.

I would rather not create and maintain a second .gitconfig for those remote servers. Is there a way to do something like this:

[core]
    if [[ $IS_REMOTE -eq 1 ]]; then
        editor = "vim"
    else
        editor = "subl -n -w"
    fi

where I've somehow set $IS_REMOTE based on the hostname?

Upvotes: 45

Views: 14744

Answers (7)

Ciaran Courtney
Ciaran Courtney

Reputation: 29

Since Git v2.31 you could also set environment variables in your .bashrc or whatever, e.g. on WSL2 I use the following to configure git to used the cached git https credentials from Windows:

export GIT_CONFIG_COUNT=2 \
GIT_CONFIG_KEY_0="credential.helper" GIT_CONFIG_VALUE_0="/mnt/c/Program\ Files/Git/mingw64/libexec/git-core/git-credential-manager-core.exe" \
GIT_CONFIG_KEY_1="credential.https://dev.azure.com.usehttppath" GIT_CONFIG_VALUE_1="true"

Credit to VonC for pointing this out https://stackoverflow.com/a/65963666/9189668

Upvotes: 1

John McGehee
John McGehee

Reputation: 10299

You can conditionally include another Git config file based on your Git directory or branch in Git 2.13 and later.

Put your default configuration in file ~/.gitconfig as usual. At the end, conditionally include another configuration file:

[user]
    email = [email protected]
    name = John McGehee

# All work Git repositories are in a subdirectory of ~/work.
# All other Git repositories are outside ~/work.
[includeIf "gitdir:~/work/"]
    path = .gitconfig.work

Then, in ~/.gitconfig.work add or override configuration values you want when using a repository located in ~/work or any subdirectory thereof:

[user]
    email = [email protected]

You can observe the difference by changing to a Git directory under ~/work, and running:

git config user.email

Try the same command in a Git directory that is not under ~/work.

Upvotes: 43

childno͡.de
childno͡.de

Reputation: 4816

not exactly an answer to your question but interesting for related usecases: since git 1.8.5 you are allowed to use urlmatch syntax

see http://git-scm.com/docs/git-config for details

config entries regarding remotes are the only one that can be defined conditionally like [http "https://localhost" ] sslVerify = false

^ will switch of ssl verification for localhost "remotes" only

Upvotes: -1

Anton Backer
Anton Backer

Reputation: 364

The [include] section learned by git-config in v1.7.9 gets you most of the way there.

While it doesn't let you write runtime conditionals, it does give you a framework for refactoring your ~/.gitconfig into several parts: the shared section, and the env-specific sections. After that, you can symlink something like ~/.gitconfig.local to the relevant env-specific config file, and include ~/.gitconfig.local from ~/.gitconfig.

The symlinking part can be scripted and done automatically as part of your dotfiles' init script.

From the command line, that include path can be added via:

git config --global include.path '~/.gitconfig.local'

I use the quotes above specifically to prevent the shell from expanding ~ to an absolute path.

That adds the following section to your ~/.gitconfig:

[include]
    path = ~/.gitconfig.local

Here's a snippet from the git-scm book showing the general format:

[include]
    path = /path/to/foo.inc ; include by absolute path
    path = foo ; expand "foo" relative to the current file
    path = ~/foo ; expand "foo" in your $HOME directory

Upvotes: 15

Mark Nichols
Mark Nichols

Reputation: 1503

Since it isn't possible to test an environment variable and programmatically alter the .gitconfig, and since scripting the creation of two .gitconfig files feels like more work than I really want to put forth, I'm just going to create two .gitconfig files. On those machines where I can setup Sublime Text 2 as my editor, and have control over the merge tool and diff tool, I'll use the "primary" gitconfig as the target of my symbolic link. On those machines where I don't have ST2 as an option, I'll use the "secondary" gitconfig file.

Upvotes: -1

Nevik Rehnel
Nevik Rehnel

Reputation: 51935

No, Git config does not support checks or conditional statements. But your underlying shell probably does, so you can use something like:

[core]
    editor = "if [[ $IS_REMOTE -eq 1 ]]; then ED='vim'; else ED='subl -n -w'; fi; $ED"


If you need to do something more complicated than that, you could just throw the shell code into a script, of course, like

[core]
    editor = "my_edi_script.sh"

with my_edit_script.sh containing something like:

#!/bin/bash
if [[ $IS_REMOTE -eq 1 ]]; then
    ED="vim"
else
    ED="subl -n -w"
fi

$ED some argument or other

Edit: The my_edit_script.sh would have to be in the $PATH, of course :)

Upvotes: 22

Carlos Campderrós
Carlos Campderrós

Reputation: 22972

I don't think you can do this, but instead of maintaining your .gitconfig file, how about maintaining a script that generates your .gitconfig file? That way you can do whatever you want, based not only on variables but also on the output of commands and whatever...

like:

#!/bin/sh
if [ "$#" -eq 0 ]
then
    IS_REMOTE=
else
    case "$1" in
        remote)
            IS_REMOTE=1
            ;;
        local)
            IS_REMOTE=
            ;;
        *)
            echo "value $1 not supported" >&2
            ;;
    esac
fi

# config for both remote and local
git config --global color.ui true
git config --global alias.top '!pwd -L'

# config for remote
if [ "$IS_REMOTE" ]
then
    git config --global core.editor vim
    ...
else
    git config --global core.editor 'subl -n -w'
    ...
fi

So, if you call the script without parameters, or with the 'local' parameter, it will generate some configuration to your .gitconfig file, while if you pass the 'remote' parameter to it, it will generate some others.

Upvotes: 1

Related Questions