]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-cookbooks.git/commitdiff
Adds some docs on how to run the testing tools
authorWalter Huf <walter.huf@corvisa.com>
Thu, 23 Oct 2014 15:51:40 +0000 (10:51 -0500)
committerWalter Huf <walter.huf@corvisa.com>
Thu, 23 Oct 2014 15:51:40 +0000 (10:51 -0500)
README.md

index bfd307dca0dde316d93beae0d6e420c69c3b0357..d22771648d4943381140b52abe8163f2c2c7bd73 100644 (file)
--- a/README.md
+++ b/README.md
@@ -169,6 +169,27 @@ The ceph\_cephfs LWRP provides an easy way to mount CephFS. It will automaticall
 - :use\_fuse - whether to use ceph-fuse or the kernel client to mount the filesystem. ceph-fuse is updated more often, but the kernel client allows for subdirectory mounting. Defaults to true
 - :cephfs\_subdir - which CephFS subdirectory to mount. Defaults to '/'. An exception will be thrown if this option is set to anything other than '/' if use\_fuse is also true
 
+## DEVELOPING
+
+### Style Guide
+
+This cookbook requires a style guide for all contributions. Travis will automatically verify that every Pull Request follows the style guide.
+
+1. gem install bundler
+2. bundle install
+3. bundle exec rake style
+
+### Testing
+
+This cookbook uses Test Kitchen to verify functionality. A Pull Request can't be merged if it causes any of the test configurations to fail.
+
+1. gem install berkshelf
+2. gem install bundler
+3. bundle install
+4. bundle exec kitchen test aio-debian-74
+4. bundle exec kitchen test aio-ubuntu-1204
+4. bundle exec kitchen test aio-ubuntu-1404
+
 ## LICENSE AND AUTHORS
 
 * Author: Kyle Bader <kyle.bader@dreamhost.com>