From 3c6fc4262330aee43f2be12290bbb08210cd1620 Mon Sep 17 00:00:00 2001 From: Karl Matthias Date: Tue, 27 Aug 2013 12:20:42 +0100 Subject: [PATCH] Added explanation of how to disable tagging in the README. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index b858a2f..ee0599b 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,24 @@ work. The easiest way around this problem is to simply commit your changes before you deploy. You do not have to push them. The plugin will then happily carry on deploying without complaint. +Disabling Tagging for a Stage +----------------------------- +Sometimes you do not want to enable deployment tagging for a particular +stage. In that event, you can simply disable tagging by setting `no_deploytags` +lik so: + +```ruby +set :no_deploytags, true +``` + +You can also set this from the command line at any time with `-S no_deploytags`. + +*NOTE:* this will disable the use of the plugin's functionality entirely for +that stage. The tasks will run, but will do nothing. This means that tasks that +are hooked to the Capistrano Deploytags tasks will also still run, but they may +find their expectations are not met with regards to the cleanliness of the git +tree. + Viewing Deployment History -------------------------- It's trivial to view the deployment history for a repo. From a checkout