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
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Join us tomorrow at 1 PM EST: "3-Step Approach to Comprehensive Runtime Application Security"
Save your seat
  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.

Stephen Connolly user avatar by
Stephen Connolly
·
May. 29, 19 · Tutorial
Like (5)
Save
Tweet
Share
22.49K Views

Join the DZone community and get the full member experience.

Join For Free

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 = __redacted_to_stop_spam_scrapers__@gmail.com
    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 = __redacted_to_stop_spam_scrapers__@apache.org
    signingkey = 042B29E928995B9DB963C636C7CA19B7B620D787 


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

[user]
    email = __redacted_to_stop_spam_scrapers__@cloudbees.com
    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.

Popular on DZone

  • Spring Boot Docker Best Practices
  • Project Hygiene
  • Fraud Detection With Apache Kafka, KSQL, and Apache Flink
  • Beginners’ Guide to Run a Linux Server Securely

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

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

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: