How to use Github to manage dotfiles?

Question

I stored my dotfiles in github, with lots pains, because of no automation. I have to update it myself.

Is there a way that can auto install/update/sync dotfiles? I m

Answer 1

I'm using git repository (github) and bash script to creating symlinks. But now I found this tool which seems to be more powerful. Check it out: https://github.com/shanx/python-dotfiles.

Answer 2

Well, it's three years later and nobody has come up with anything great so i took a stab at this problem. It's platform agnostic and shell agnostic with no dependancies other then the bourne compatible shell you have available(bash, zsh, ksh, etc). It works on mac, linux, & windows:

dotsys

It will automatically synchronize changes to your dotfiles with github and multiple machines, along with many other features.

Answer 3

The main idea is having a separated directory (usually called .dotfiles) with all the real dotfiles which you want to keep track in git and having symbolic links in the home directory.

There is already a lot of work done for this approach so I will recommend you to check DFM (dotfiles manager):

• Here is my dotfiles selection using dfm (you can consider it an example): vicente's dotfiles
• Github official repository DFM site

Answer 4

You update/sync your dotfiles with git push/pull commands (GitHub acting as 'central' repository). When it comes to symlinking dotfiles I wrote an article about it. Check it out: manage your dotfiles with ease.

Answer 5

The above answers are excellent and are exactly how I would do it on "real operating systems".

I ran into an issue with this on a well-known commercial OS using cygwin/msys whereby using symlinks can sometimes be problematic with "native" ports of some of my favorite software.

To work around this I experimented with just making the folder $HOME be a git repository directly. After some failures I found the key is all in the .gitignore file.

So the setup I've been using for a while was created by making $HOME a repository, making a .gitignore file, and adding the required "dotfiles" files individually. I also added a repository on a backup up drive (z: in this case) as an upstream just to gain the automatic backups. If you're folder is already backed up, adding an upstream is an unnecessary complication. So, assuming "/z/Backups/Dotfiles.git" is a pre-existing "bare" repository, in msys shell, the steps to set things up are:

$ cd $HOME
$ git init
Initialised empty Git repository in $HOME
$ git add .bashrc .emacs .gitconfig # for example
$ git commit -m "Initial import of dotfiles"
[master (root-commit) xxxxxxxx] Initial import for dotfiles
 3 files changed, xxx instertions(+)
 create mode 100644 .bashrc
 create mode 100644 .emacs
 create mode 100644 .gitconfig

# The following two lines just add an "upstream" purely for backup purposes.
$ git remote add origin /z/Backups/Dotfiles.git
$ git push -u origin master
<< snip >>

Next I put the following into $HOME/.gitignore:

# First exclude everything.
*
# then re-include all "dotfiles"
!/.*
# then a bunch of specific excludes as they are more-or-less "cache" data rather than configuration.
/.bash_history
/.dbus-keyrings/
/.emacs.d/
/.gimp-2.8/
/.git/
/.gitk
/.idlerc/
/.lesshst
/.saves/
/.thumbnails/

Finally the following commands (apologies I didn't capture the output from these) add the .gitignore itself to the repository:

$ cd $HOME
$ git add .gitignore
$ git commit -m "Added some rules so git status on the dotfiles is useful."
$ git push

Now any "normal" files you add to your home dir get ignored by the dotfiles repo, but any new dotfiles show up in git status e.g.:

$ cd $HOME
$ touch NewFile.txt
$ git status
On branch master
Your branch is up-to-date with 'origin/master'.

nothing to commit, working directory clean

$ touch .funkychicken
$ git status
On branch master
Your branch is up-to-date with 'origin/master'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)

        .funkychicken

nothing added to commit but untracked files present (use "git add" to track)

So far this has been working well, even with some subdirs being their own (unrelated) git repository. Sometimes there are "quirks" with non-git subdirs, but so far nothing problematic.

Answer 6

I found an interesting way to use plain git to manage your dotfiles, no symlinks needed. This way, you should be able to do push and pull the usual way:

Setup

git init --bare $HOME/.myconf
alias config='/usr/bin/git --git-dir=$HOME/.myconf/ --work-tree=$HOME'
config config status.showUntrackedFiles no

where my ~/.myconf directory is a git bare repository.

Usage

The usual git commands can then be used with the git alias, e.g. config or whatever you choose.

config status
config add .vimrc
config commit -m "Add vimrc"
config push

Benefits

• No extra tooling
• no symlinks

More Infos

• Source: https://news.ycombinator.com/item?id=11071754
• Article with further infos: https://developer.atlassian.com/blog/2016/02/best-way-to-store-dotfiles-git-bare-repo/