From 830625b8360108b5c93931a8eb93b9c64c5f0fcf Mon Sep 17 00:00:00 2001 From: Mark Heiges Date: Fri, 2 Sep 2016 09:51:34 -0400 Subject: [PATCH] updated README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 7fd3d92..4e300fa 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,31 @@ that module's documentation at https://github.com/EuPathDB/puppet-ebrc_jenkins for details. +`ebrc_jenkins` Puppet module development +======= + +A primary use case for this project is for development on the +[`ebrc_jenkins`](https://github.com/EuPathDB/puppet-ebrc_jenkins) Puppet +module. Before editing code in `puppet/modules/ebrc_jenkins` be aware of +how Vagrant is managing all the puppet requirements. + +This project uses the Vagrant `vagrant-librarian-puppet` plugin to +manage module dependencies. Librarian's default behavior is to delete +and repopulate the `puppet/modules` directory. Obviously puts +uncommitted `ebrc_jenkins` module code at risk. To temporarily disable +this default behavior, `touch nolibrarian` in the same directory as the +`Vagrantfile`. With this file in place, librarian will not remove your +uncommitted code. Remove the `nolibrarian` file to restore the behavior +(just be sure to `git commit` first). + +Note that librarian clones a specific git commit of `ebrc_jenkins` that +is detached from HEAD. You should correct this before developing on the +module so you will be able to commit your changes. + +When restoring librarian, you typically will need to remove +`Puppetfile.lock` so it will be regenerated with the latest commit +version of `ebrc_jenkins`. + Manual Puppet Run =======