Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
codesnik committed Jul 22, 2009
1 parent 0604d6c commit fa81ed4
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.rdoc
Expand Up @@ -5,39 +5,48 @@ on first server in a cluster

== Synopsis

# starts script/console on the first :app server in currently released directory
# be careful with your production server data - it's the power under your fingers now!
starts script/console on the first :app server in currently released directory
be careful with your production server data - it's the power under your fingers now!

cap rails:console

# starts script/dbconsole, still on the :app server, but connected to a
# right database, probably
starts script/dbconsole, still on the :app server, but connected to a
right database, probably

cap rails:dbconsole

# even this should work, providing you authenticate via ssh key
# and you're not using ssh gateway (breaks pipeline sometimes)
even this should work, providing you authenticate via ssh key
and you're not using ssh gateway (breaks pipeline sometimes)

cap rails:dbconsole < sqldump.sql

# sorry, haven't figured how to provide additional arguments for rake yet.
sorry, haven't figured how to provide additional arguments for rake yet.

cap rails:rake task=db:abort_if_pending_migrations

# do not try it at work
cap rails:runner cmd='User.delete_all'
(NOT DONE YET) do not try it at work

# using some multistage deployment scheme (capistrano/ext/multistage or something homebrew)?
# this should work too right from the box
(NOT DONE YET) cap rails:runner cmd='User.delete_all'

using some multistage deployment scheme (capistrano/ext/multistage or something homebrew)?
this should work too right from the box

cap staging rails:console

== Installation

TODO
sudo gem install codesnik-rails-recipes --source=http://gems.github.com

then stick

require 'rails-recipes'

at the end of your Capfile or ~/.caprc

== Configuration

TODO

== Hidden details

It doesn't use ruby net/ssh2 library for interactive script/console and script/dbconsole
Expand Down
46 changes: 46 additions & 0 deletions rails-recipes.gemspec
@@ -0,0 +1,46 @@
# -*- encoding: utf-8 -*-

Gem::Specification.new do |s|
s.name = %q{rails-recipes}
s.version = "0.0.1"

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Alexey 'codesnik' Trofimenko"]
s.date = %q{2009-07-22}
s.email = %q{aronaxis@gmail.com}
s.extra_rdoc_files = [
"LICENSE",
"README.rdoc"
]
s.files = [
".document",
".gitignore",
"LICENSE",
"README.rdoc",
"Rakefile",
"VERSION",
"lib/rails-recipes.rb",
"lib/rails-recipes/console.rb",
"test/rails-recipes_test.rb",
"test/test_helper.rb"
]
s.homepage = %q{http://github.com/codesnik/rails-recipes}
s.rdoc_options = ["--charset=UTF-8"]
s.require_paths = ["lib"]
s.rubygems_version = %q{1.3.3}
s.summary = %q{capistrano recipes for invoking script/console, script/dbconsole and rake on a rails app server}
s.test_files = [
"test/rails-recipes_test.rb",
"test/test_helper.rb"
]

if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 3

if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
else
end
else
end
end

0 comments on commit fa81ed4

Please sign in to comment.