Suggestions for documentation

[dougc84]

I have to say @mislav - I tried this little gem out tonight, and it's absolutely amazing. Forget Capistrano.

However, I did want to patch a few notes your way to add to the readme, if you so desire:

git deploy hooks and other git deploy ... commands should be suffixed with -r production or whatever the repo name is; otherwise it uses origin.

deploy/restart should always be updated depending on the server. I run unicorn, not passenger, and I was wondering for a few minutes why the server didn't restart. Duh, but this note might save someone some time.

Verbose output: personally, I could care less about a log file on the server - I would rather have the information displayed right away, as it really doesn't tell you what's going on. I did the following to display all the goodness right in the console:

On the remote server, go to /your/app/path/.git/hooks and open up post-receive in your editor. At the bottom of the file, change the line:
[ -x deploy/after_push ] && nohup deploy/after_push $oldrev $newrev 1>>$logfile 2>>$logfile &
to:
[ -x deploy/after_push ] && nohup deploy/after_push $oldrev $newrev
and bundling, asset compilation, migrations, etc. will all be displayed.

Again, killer job on this gem. I will definitely be using it a heck of a lot more often.

[mislav]

Hi, thanks for the feedback!

1. Yeah, the -r option can be pretty important. However, its usage is already demonstrated both in the README and git-deploy -h. Where would you like to additionally document it?
2. Yup, this is pretty important. I don't think it's stressed out in the README enough. We could additionally link to a wiki page that offers examples of how might a Unicorn restart script look like.
3. Verbose output: that has already been fixed in 64d75f3 and released with v0.6.0. However, people who had installed their post-receive hook before that will need to update, perhaps manually like you did.

[dougc84]

1. In the bottom section of the README. I didn't notice it anywhere else.
2. A wiki page would be helpful for some more in-depth stuff, though you've documented the README quite extensively (thank you for that)
3. Interesting. I just installed it tonight from a fresh bundle install, and I wasn't getting really anything except the git receive message - no bundle, assets messages, anything.

[mislav]

A for (3), when you upgrade git-deploy, the remote hooks that you installed with an older version remain unchanged, unless you explicitly overwrite them with git deploy hooks

[talakoski]

+1 for adding documentation for using -r option. Good for people who prefer reading hours README and source code instead of using -h :)