How to store a git config as part of the repository?

by

There are 3 supported scopes of .gitconfig file: --system, --global, --local. You can also create a custom configuration file, and include it in one of the supported files.

For your needs custom – is the right choice. Instead of writing your filter in .git/config you should save it in .gitconfig file in your repository root:

your-repo/
│
├── .git/
│   ├── config
│
├── .gitconfig
│

Create the .gitconfig with your filter and commit the changes. Then your colleagues will always keep it updated — but they will have to include it manually. It is not possible to automatically include your custom configuration file through git alone, because it creates a security vulnerability.

To apply this configuration for a single repository, each user will need to run the following command in your-repo/:

git config --local include.path ../.gitconfig

Reference: https://git-scm.com/docs/git-config#_includes

Be careful not to store personal data in the custom .gitconfig, like user.*, keep those in your global .gitconfig.

More Related Contents:

  1. Can I specify multiple users for myself in .gitconfig?
  2. How to reset all files from working directory but not from staging area?
  3. How do I pull from a Git repository through an HTTP proxy?
  4. fatal: early EOF fatal: index-pack failed
  5. Apply gradle file from different repository
  6. Git equivalent of subversion’s $URL$ keyword expansion
  7. Rename master branch for both local and remote Git repositories
  8. What is the Difference Between Mercurial and Git?
  9. How do I rename both a Git local and remote branch name?
  10. How to move certain commits to be based on another branch in git?
  11. Git Push ERROR: Repository not found
  12. How can I search Git branches for a file or directory?
  13. Make Git automatically remove trailing white space before committing
  14. Find merge commit which include a specific commit
  15. How to find the commit in which a given file was added?
  16. Remove refs/original/heads/master from git repo after filter-branch –tree-filter?
  17. How can I automatically deploy my app after a git push ( GitHub and node.js)?
  18. Choose Git merge strategy for specific files (“ours”, “mine”, “theirs”)
  19. There isn’t anything to compare. Nothing to compare, branches are entirely different commit histories
  20. Git is changing my file’s permissions when I push to server
  21. Remove directory from remote repository after adding them to .gitignore
  22. GitHub – fatal: could not read Username for ‘https://github.com’: No such file or directory
  23. How can I configure KDiff3 as a merge tool and diff tool for git?
  24. Sharing rerere cache
  25. Why are connections to GitHub over SSH throwing an error “Warning: Remote Host Identification Has Changed”?
  26. Undo a git stash
  27. How to create a new (and empty!) “root” branch?
  28. How to list files ignored with ‘skip-worktree’
  29. Calling ‘git pull’ from a git post-update hook
  30. How do I show my global Git configuration?

Leave a Comment