DEVELOPERS.md

Developer's Guide

1. Set up the environment
2. Check the formatting
3. Run the tests
4. Build the module
5. Install the module
6. Other useful commands

Run the following commands from the top-level module directory (where Modulefile resides), unless otherwise noted.

##Set Up the Environment

Prerequisites: puppet, ruby, gem, and the bundler and rcov (for code coverage checks) gems.

1. Clone this project:

    git clone git://github.com/sprater/puppet-fcrepo
    cd puppet-fcrepo

2. Set your environment variables:

    BUNDLE_GEMFILE=.gemfile
    export BUNDLE_GEMFILE

3. Install the gems needed for development and testing:

    bundle install --gemfile .gemfile

##Check the formatting

Make sure the module conforms to the Puppet Labs Style Guide:

bundle exec rake lint

##Run the tests

Run the tests under the spec/ directory:

bundle exec rake spec

##Build the module

Build the module as a tar-gzipped package, ready for install into puppet:

puppet module build .

##Install the module

Install the module, ignoring any upstream Puppet Forge dependencies:

sudo puppet module install pkg/sprater-fcrepo-<version>.tar.gz --ignore-dependencies

##Other useful commands

###Clean the built module package

bundle exec rake clean

###Clean the rspec tests

bundle exec rake spec_clean

###Check your test coverage

bundle exec rake coverage