README.md in knife-spork-1.0.3 vs README.md in knife-spork-1.0.4
- old
+ new
@@ -36,11 +36,12 @@
```yaml
default_environments:
- development
- production
-version_change_threshold:
+version_change_threshold: 2
+environment_path: "/home/me/environments"
plugins:
campfire:
account: myaccount
token: a1b2c3d4...
hipchat:
@@ -67,9 +68,12 @@
#### Default Environments
The `default_environments` directive 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 KnifeSpork will promote to all environments in this list.
#### Version Change Threshold
The `version_change_threshold` directive allows you to customise the threshold used by a safety check in spork promote which will prompt for confirmation if you're promoting a cookbook by more than version_change_threshold versions. This defaults to 2 if not set, ie promoting a cookbook from v1.0.1 to v 1.0.2 will not trip this check, wheras promoting from v1.0.1 to v1.0.3 will.
+
+#### Environment Path
+The `envirinment_path` allows you to specify the path to where you store your chef environment json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments"
#### Plugins
Knife spork supports plugins to allow users to hook it into existing systems such as source control, monitoring and chat systems. Plugins are enabled / disabled by adding / removing their config block from the plugin section of the config file. Any of the default plugins shown above can be disabled by removing their section.
For more information on how to develop plugins for spork, please read the plugins/README.md file.