git-profiles

Directory-based configuration management for Git -- simplified. Add a fourth config file to your git configuration loader. Manage any Git config settings on a directory-based level!

DEPRECATION NOTICE

In git v2.13, support for conditional inclusions was added. This means that this project no longer adds functionality that cannot be accomplished through the core git library itself. For transitioning, you should read the documentation on conditional includes.

THIS REPOSITORY IS NO LONGER MAINTAINED

A quick example of how to use conditional includes to gain the functionality provided by this project can be seen below. Again, it is highly recommended that you read the documentation.

.gitconfig

[includeIf "gitdir:/code/work/"]
    path = ~/.profile-for-work.gitconfig

[includeIf "gitdir:/code/work/some-repo/.git"]
    path = ~/.profile-for-some-repo.gitconfig

---

What follows is the former README contents:

Overview

When you run a Git command, like git commit, Git looks in three different configuration files for different settings, for things like the user.name and user.email settings, in the following order:

• Your system-level configuration (git config --system --edit)
• Your global-level configuration (git config --global --edit)
• Your local-level configuration (git config --local --edit)

Each of the above configuration files overrides the other -- if your local config has a user.name setting, then Git will use that value instead of your global configuration's user.name setting. This enables you to control your identity in different repositories.

The issue some people have, however, is that they do not want to have to set their configuration settings for every repository they create. This project aims to enable a fourth configuration file for easier identity management - the workspace level.

How it works

This project provides a custom shell function named git(), which handles temporarily injecting a workspace profile into your global configuration, so that it overrides global settings, but is overridden by any local settings. It accomplishes this by looking for a .gitprofile file inside any directories defined in your global configuration's profiles.path keys.

Installation

First, clone the repository to your local machine.

git clone https://github.com/bddenhartog/git-profiles.git

Next, run the install command.

make install

This adds a line to your existing runcom script(s) that source git-profiles.sh so that the git() wrapper function overrides your calls to git <command>. Make sure to start a new shell session after installation.

Automatic installation currently supports:

• Bash - .bashrc
• Zshell - .zshrc
• MirBSD Korn - .mkshrc

If the runcom you use isn't listed above, you can install git-profiles manually by sourcing the script directly:

source "/path/to/git-profiles.sh"

Usage

Let's take an example workspace structure from an imaginary programmer named > Bob:

/code
|
|- office/
|  |- some-work-repo/
|
|- personal/
|  |- bobs-repo/
|
|- client/
|  |- some-other-project/

Each of the tertiary child directories is a Git repository, and Bob manages three different identities - bob@office.xyz, bob@personal.xyz, and bob@client.xyz. In order to avoid having to manually add each identity to every repository he ever creates in these directories, he can just use the git() function wrapper provided by this project.

First, create a profile

Bob will create a .gitprofile file in each of the parent directories:

/code/office/.gitprofile
/code/personal/.gitprofile
/code/client/.gitprofile

These .gitprofile files work exactly like a .gitconfig file:

[user]
    name = Bob McBobberson
    email = bob@office.xyz

Tip: Set keys and values using git by adding the --file option!

$ git config --file /code/office/.gitprofile user.name "Bob Mcbobberson"

Next, tell the global configuration about it

git config --global --add profiles.path /code/office
git config --global --add profiles.path /code/personal
git config --global --add profiles.path /code/client

This adds a key/value pair in your global configuration.

NOTE If you previously added paths with profile.path, you should edit your global configuration file and change the [profile] section to [profiles]. See this issue for more information.

That's all, folks

The next time you run a git command, your configured directory profiles will be picked up.