DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Newsletter
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Developer Git Commit Hygiene
  • Understanding Git
  • Shrink a Bloated Git Repository and Optimize Pack Files
  • A Comprehensive Guide to GitHub

Trending

  • Constrained Decoding Models Explained: Encoders, Decoders and When to Use Them
  • PWA on iOS, Part 3: Chrome on iPhone Is WebKit Too. How One Engine Sets the Rules for PWAs on iOS
  • Building a Real Pipeline With senro: Monorepos, Caching, and Triggers
  • One Identity Unveils Active Roles 8.6 with Enhanced Security and Administration

Draft This article hasn't been published, so readers can't see it.

In moderation This article is waiting for review, so readers can't see it yet.

Deleted This article has been deleted, so readers can't see it.

  1. DZone
  2. Testing, Deployment, and Maintenance
  3. Deployment
  4. How to Use .gitconfig's includeIf

How to Use .gitconfig's includeIf

Here's an easy way to segment your work so you can easily commit to repos with different identities using includeIf.

By 
Stephen Connolly
·
May. 29, 19 · Tutorial
Post on X (opens in a new tab) Share on LinkedIn (opens in a new tab)
28.0K Views

Join the DZone community Save articles, join the discussion, and download Refcards and Trend Reports with a free account.

Join for free Already a member? Log in

Problem

I want to have my commits to Git use the appropriate email address. I don’t want to have to remember to call  git config user.email … every time I check out a new repository.

Background

When I check out a repository hosted by the Apache Software Foundation, I check it out inside of ~/apache/. I want to commit to these repositories as my apache.org email address and signed with my GPG key for that address.

When I check out a repository hosted by work, I check it out inside of ~/src/. I want to commit to these repositories as my cloudbees.com email address and signed with my GPG key for that address.

Everything else should be committed as my Gmail email address and signed with my GPG key for that address.

Solution

Git has a wonderful directive called [includeIf]. Basically, with this directive, you can import an additional configuration file based on a condition being true.

So my ~/.gitconfig file looks something like this:

[user]
    name = Stephen Connolly
    email = [email protected]
    signingkey = 19AA78492C2E0E75929F2882826B365485623138 

...

[commit]
    gpgsign = true
[gpg]
    program = gpg
[includeIf "gitdir:~/apache/"]
    path = ~/.gitconfig-apache
[includeIf "gitdir:~/src/"]
    path = ~/.gitconfig-cloudbees


And then I have ~/.gitconfig-apache, which looks like:

[user]
    email = [email protected]
    signingkey = 042B29E928995B9DB963C636C7CA19B7B620D787 


And ~/.gitconfig-cloudbees, which looks like:

[user]
    email = [email protected]
    signingkey = 19ACC26DFF642A36072626405B1D58B53F3F7A0E 


And now, because of the way I structure checking out code, my commits reflect the correct identities.

Repository (version control) Commit (data management) Git Directive (programming) Gmail Software Foundation (framework)

Published at DZone with permission of Stephen Connolly. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Developer Git Commit Hygiene
  • Understanding Git
  • Shrink a Bloated Git Repository and Optimize Pack Files
  • A Comprehensive Guide to GitHub

Partner Resources

×

Comments

Loading comments

The comments didn't load

Please try again in a moment.

Likes

Loading

The next likes didn't load. Please try again.

The likes didn't load

Please try again in a moment.

See who liked this

Log in or join DZone for free to see who liked this article.

Log in Join for free
  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook