- Depend easily on other packages (single-command update)
- Keep everything under version control
- Have idempotent yet flexible script that sets everything up
I want to be able to easily depend on other packages for my dotfiles, such as oh-my-zsh, or janus. When I say "easily depend" I mean being able to run a single command to get the latest package updates without having to redo my customizations. That's the main goal. The second goal is to keep everything under public version control (meaning, private stuff is consolidated and easily gitignored). The third goal is to have a consistent and idempotent, yet flexible bootstrap script. I decided to go the rake route, since I'm a rubyist, and rake is packaged with ruby by default, thus available on every mac.
The default rake task runs the following chain.
[ :download, :build, :install ]
The main idea here is that the files and directories in the root of git repo are not the ones being used, they are only the source files. You can modify them and run rake to update your actual dotfiles, which reside in
build dir. This separation enables a couple of important possibilities.
- it's possible to run erb on config files
- it's possible to patch dependencies while preserving the clean state for updates
Essentially, the rake task creates
build directory, initializes submodules (oh-my-zsh, etc), copies everything to
build dir, parses every
foo.erb replacing it with
foo, performs any custom
post_build tasks, then symlinks the specified files and directories to your home dir.
post_build tasks include things like symlinking the custom zsh directory into
oh-my-zsh, and adding my theme to
oh-my-zsh, because they don't have a customization hook for that.
cd ~ git clone git://github.com/maxim/dotfiles.git Dotfiles cd Dotfiles rake
cd ~/Dotfiles rake osx
cd ~/Dotfiles # make changes rake
cd ~/Dotfiles rake update
Removes symlinks too, be careful
cd ~/Dotfiles rake cleanup
Copyright (c) 2011 Maxim Chernyak
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.