README.md in knife-spork-1.3.0 vs README.md in knife-spork-1.3.1
- old
+ new
@@ -1,9 +1,11 @@
KnifeSpork
===========
KnifeSpork is a workflow plugin for `Chef::Knife` which helps multiple developers work on the same Chef Server and repository without treading on each other's toes. This plugin was designed around the workflow we have here at Etsy, where several people are working on the Chef repository and Chef Server simultaneously. It contains several functions, documented below:
+[](http://badge.fury.io/rb/knife-spork)
+
Installation
------------
### Gem Install
`knife-spork` is available on rubygems. Add the following to your `Gemfile`:
@@ -46,10 +48,11 @@
- acceptance_testing
version_change_threshold: 2
environment_path: "/home/me/environments"
role_path: "/home/me/roles"
custom_plugin_path: "/home/me/spork-plugins"
+always_promote_remote: true
plugins:
campfire:
account: myaccount
token: a1b2c3d4...
foodcritic:
@@ -90,9 +93,13 @@
#### Environment Groups
The `environment_groups` directive allows you to specify a list of environments referenced by group names that you want to promote changes to.
#### 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.
+
+#### Always Promote Remote
+The `always_promote_remote` directive allows you to tell spork promote to always act as if the --remote option had been specified. This will also have the same effect on spork omni. This option should only be used if you're sure you want all changes to be uploaded to the server as soon as you run promote.
+
#### Environment Path
The `environment_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"
#### Role Path
\ No newline at end of file