vagrant-git is a Vagrant plugin for checking out and updating git repos. It has a very simple configuration to either clone or pull repositories after a VM boots (but before it's provisioned).
The plugin doesn't do anything special, but it helps to centralise environment configuration declaratively in the Vagrantfile, rather than relying on scripting.
Currently the plugin only supports cloning into the host machine, so care should be taken to clone the repositories into a directory accessible by the guest. vagrant-sparseimage integrates well for this use job, or a standard file share should be use.
When you run vagrant up or vagrant provision, this plugin will clone or pull the various specified git repos. It does not attempt to handle a dirty working tree: git pull will simply fail. This is to prevent mistakenly clobbering any changes. In order to get a
Planning to implement a command - vagrant git - supporting list, pull, clone and reset to streamline this a little.
Only supports Vagrant > 1.2.
Requires git.
See building below for building the gem.
Use vagrant plugin to install the gem in your Vagrant environment:
$ vagrant plugin install vagrant-gitSee example-box/vagrantfile for an example configuration.
The following config properties for config.git are required:
- target: string: the repository to clone. This must be a fully qualified git ref spec.
- path: string: the path in the host or the guest to clone or pull the repo into
The following properties are optional (but not yet supported):
- branch: Which branch to check out / pull
- clone_in_host: boolean: true to execute git commands in the host, false to execute them in the guest. NOT YET SUPPORTED for false.
- sync_on_load: whether to do a fetch & pull when starting up the VM
- set_upstream: a different remote URL to set the upstream origin to after cloning the repository
$ bundle install
$ cd ./example-box/
$ bundle exec vagrant up