From a24c306e6b8d7704fe2bce0dd707391e092fa9f3 Mon Sep 17 00:00:00 2001 From: Karl Matthias Date: Tue, 27 Aug 2013 11:53:38 +0100 Subject: [PATCH] Updated README to talk about editing deployment scripts. --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c3a52f3..b858a2f 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,19 @@ In your Capistrano `config/deploy.rb` you should add: This will create two tasks, one that runs before deployment and one that runs after. -NOTE: You will be creating and pushing tags from the version of the -code in the current checkout. This plugin needs to be run from a -clean checkout of your codebase. You should be deploying from a -clean checkout anyway, so in most cases this is not a restriction -on how you already do things. The plugin will check if your code -is clean and complain if it is not. +NOTE: You will be creating and pushing tags from the version of the code in the +current checkout. This plugin needs to be run from a clean checkout of your +codebase. You should be deploying from a clean checkout anyway, so in most +cases this is not a restriction on how you already do things. The plugin will +check if your code is clean and complain if it is not. + +Working on Your Deployment Scripts +---------------------------------- +Because you must have a clean tree to deploy, working on your deployment +scripts themselves can be a bit frustrating unless you know how to make it +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. Viewing Deployment History --------------------------