Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 103 lines (66 sloc) 2.985 kB
bff18d6 @nickrivadeneira follow nokogiri's example
nickrivadeneira authored
1 # Kumade 熊手 [![Build Status](https://secure.travis-ci.org/thoughtbot/kumade.png)](http://travis-ci.org/thoughtbot/kumade)
abb3609 @gabebw Kumade is not a set of Rake tasks.
gabebw authored
2 Kumade is a command-line program for deploying to Heroku. It aims to
70aefaf @gabebw Add a README
gabebw authored
3 provide most of what you want. Unlike other Heroku deploy gems, it is
4 well-tested.
5
4146cd0 @mike-burns Deprecated
mike-burns authored
6 # Deprecated!
7
8 Kumade is deprecated. Please use the Cedar stack on Heroku instead.
9
279af21 @gabebw Development is happening fast
gabebw authored
10 ## Development
11 Development is happening very fast, and the internals are in constant flux. The
12 public API is constant (e.g. `kumade production` will work), but you may have to
13 rebase against master a couple times before your pull request can be merged.
14
70aefaf @gabebw Add a README
gabebw authored
15 ## What does Kumade do?
56fd720 @tapajos It is not true
tapajos authored
16 Before deploying, Kumade ensures the git repo is clean.
70aefaf @gabebw Add a README
gabebw authored
17 After that, it packages assets using
594a6d0 @gabebw Remove MorePackager.
gabebw authored
18 [Jammit](http://documentcloud.github.com/jammit/) (if it's installed), commits
19 them, and pushes to origin.
e9aa04a @gabebw Update README.
gabebw authored
20 Then it force pushes to the correct Heroku remote, runs `rake db:migrate` on the
9679018 @hoverlover Run kumade:post_deploy if deployment succeeds.
hoverlover authored
21 Heroku app, and then restarts the app. If all of this succeeds, it will
22 also run the rake task `kumade:post_deploy` if it is defined.
70aefaf @gabebw Add a README
gabebw authored
23
5c231e6 @gabebw Update README
gabebw authored
24 If any step fails, it immediately prints an error and stops the deploy
70aefaf @gabebw Add a README
gabebw authored
25 process.
26
27 ## Install
28 In your Gemfile:
29
c0d12cb @gabebw Use regular markdown.
gabebw authored
30 gem 'kumade'
70aefaf @gabebw Add a README
gabebw authored
31
32 ## Usage
9dda7ee @nickrivadeneira invoke deploy:assets rake task if it exists on deploy before committi…
nickrivadeneira authored
33
bce4682 @gabebw Pass in -c to use Cedar. Update README
gabebw authored
34 kumade will deploy to any Heroku remote in the repo.
ee04efc @gabebw Update README. Thanks, @tapajos.
gabebw authored
35 For example, if you have a remote named "staging":
70aefaf @gabebw Add a README
gabebw authored
36
ee04efc @gabebw Update README. Thanks, @tapajos.
gabebw authored
37 $ bundle exec kumade staging
70aefaf @gabebw Add a README
gabebw authored
38
bce4682 @gabebw Pass in -c to use Cedar. Update README
gabebw authored
39 To run in pretend mode, which prints what would be done without actually doing
40 any of it:
70aefaf @gabebw Add a README
gabebw authored
41
ee04efc @gabebw Update README. Thanks, @tapajos.
gabebw authored
42 $ bundle exec kumade staging -p
e367923 @gabebw Update README
gabebw authored
43
bce4682 @gabebw Pass in -c to use Cedar. Update README
gabebw authored
44 The default is to deploy to staging:
e367923 @gabebw Update README
gabebw authored
45
ee04efc @gabebw Update README. Thanks, @tapajos.
gabebw authored
46 # equivalent to "bundle exec kumade staging"
47 $ bundle exec kumade
70aefaf @gabebw Add a README
gabebw authored
48
abb3609 @gabebw Kumade is not a set of Rake tasks.
gabebw authored
49 ## Rake
50
8d93837 @gabebw Always load the railtie.
gabebw authored
51 Kumade auto-generates a deploy:ENV task for every Heroku environment. You don't
52 need to do anything to get the Rake tasks, they're automatically set up for you.
3eb743c @gabebw Department of redundancy department.
gabebw authored
53 If you have a "staging" remote, you would run:
abb3609 @gabebw Kumade is not a set of Rake tasks.
gabebw authored
54
55 $ rake deploy:staging
56
88dae9a @gabebw Kumade supports the Cedar stack
gabebw authored
57 ## Does it support the Cedar stack?
58
abb3609 @gabebw Kumade is not a set of Rake tasks.
gabebw authored
59 Yes. Kumade will automatically detect if your app is running on Cedar.
88dae9a @gabebw Kumade supports the Cedar stack
gabebw authored
60
1f1b17a @gabebw Ruby compatibility notes
gabebw authored
61 ## Compatibility
0839ea2 @nickrivadeneira add MIT license
nickrivadeneira authored
62
d5d2010 @gabebw Add REE to travis
gabebw authored
63 Tested against:
ed8a76e @gabebw Actually fix the bullets
gabebw authored
64
a5f31e0 @gabebw Make the bullets show up in the README
gabebw authored
65 * MRI 1.8.7
66 * MRI 1.9.2
8e73b90 @gabebw Test against 1.9.3 on Travis.
gabebw authored
67 * MRI 1.9.3
a5f31e0 @gabebw Make the bullets show up in the README
gabebw authored
68 * REE 1.8.7
1f1b17a @gabebw Ruby compatibility notes
gabebw authored
69
abb3609 @gabebw Kumade is not a set of Rake tasks.
gabebw authored
70 ## Miscellaneous Features
9dda7ee @nickrivadeneira invoke deploy:assets rake task if it exists on deploy before committi…
nickrivadeneira authored
71
1d40e91 @gabebw Explain the autogenerated Rake tasks a bit more
gabebw authored
72 Want to run a task before bundling your assets on deploy? In your Rails app's rake tasks, drop in:
9dda7ee @nickrivadeneira invoke deploy:assets rake task if it exists on deploy before committi…
nickrivadeneira authored
73
c0d12cb @gabebw Use regular markdown.
gabebw authored
74 namespace :kumade do
75 task :before_asset_compilation do
76 puts "This runs before assets are committed and pushed to the remote"
77 end
78 end
9dda7ee @nickrivadeneira invoke deploy:assets rake task if it exists on deploy before committi…
nickrivadeneira authored
79
80 You can hook in any custom code you want to run there before deploying!
81
bda3067 @gabebw Only run coverage if COVERAGE is set.
gabebw authored
82 ## Development
83 To generate coverage (only on 1.9.x), run rake with COVERAGE set:
84
85 COVERAGE=1 rake
86
70aefaf @gabebw Add a README
gabebw authored
87 ## What's with the name?
0839ea2 @nickrivadeneira add MIT license
nickrivadeneira authored
88
db51ec2 @gabebw Fix pronunciation link
gabebw authored
89 Kumade ([pronunciation here](http://translate.google.com/#ja|en|熊手)) means
70aefaf @gabebw Add a README
gabebw authored
90 "bamboo rake" in Japanese.
0839ea2 @nickrivadeneira add MIT license
nickrivadeneira authored
91
acd2b6a @mjankowski Update credits/license area to use standard format.
mjankowski authored
92 ## Credits
93
94 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
95
96 Kumade is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
97
98 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
99
0839ea2 @nickrivadeneira add MIT license
nickrivadeneira authored
100 ## License
101
2715103 Update Copyright year
Adarsh Pandit authored
102 Kumade is Copyright © 2012 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Something went wrong with that request. Please try again.