README.md in knife-spork-0.1.8 vs README.md in knife-spork-0.1.9

- old
+ new

@@ -44,10 +44,15 @@ gist: enabled: true in_chef: true chef_path: cookbooks/gist/files/default/gist path: /usr/bin/gist +foodcritic: + enabled: true + fail_tags: [any] + tags: [foo] + include_rules: [/home/me/myrules] default_environments: [ production, development ] ```` ## Git This section enables a couple of git commands which will run as part of your spork workflow, namely: @@ -67,9 +72,21 @@ This lets you send to a graphite metric when promote --remote is performed. It send to the metric deploys.chef.<environment> ## Gist This allows you to generate an optional gist of environment changes which will be added to irccat notifications on promote --remote. It supports the https://rubygems.org/gems/gist, and contains two parameters to use a version in your chef repo, or a version installed somewhere else locally. + +## Foodcritic + +This allows you to run a foodcritic lint check against your cookbook before spork uploading. The check only runs against the cookbook you've passed to spork-upload on the command line. + +PLEASE NOTE: Due to it's many dependancies (gem dependancy Nokogiri requires libxml-devel, libxslt-devel), foodcritic is not specified as a dependency of the knife-spork gem as it won't install without other manual package installs, so if you want to use it you'll need to make sure it's installed yourself for now. This may change in a future version. + +The optional attributes for this section work as follows: + +fail_tags: Fail the build if any of the specified tags are matched. +tags: Only check against rules with the specified tags. +include_rules: Additional rule file path(s) to load. ## Default Environments This allows you to specify a default list of environments you want to promote changes to. If this option is configured and you *ommit* the environment parameter when promoting, ie knife spork promote <cookbook>, then it will promote to all environments in this list.