Skip to content

Instantly share code, notes, and snippets.

@njvitto
Forked from RSpace/deploy.rake
Created April 11, 2010 16:56
Show Gist options
  • Save njvitto/362873 to your computer and use it in GitHub Desktop.
Save njvitto/362873 to your computer and use it in GitHub Desktop.
Rakefile to deploy and rollback to Heroku in two different environments (staging and production) for the same app
#Deploy and rollback on Heroku in staging and production
task :deploy_staging => ['deploy:set_staging_app', 'deploy:push', 'deploy:restart', 'deploy:tag']
task :deploy_production => ['deploy:set_production_app', 'deploy:push', 'deploy:restart', 'deploy:tag']
namespace :deploy do
PRODUCTION_APP = 'YOUR_PRODUCTION_APP_NAME_ON_HEROKU'
STAGING_APP = 'YOUR_STAGING_APP_NAME_ON_HEROKU'
task :staging_migrations => [:set_staging_app, :push, :off, :migrate, :restart, :on, :tag]
task :staging_rollback => [:set_staging_app, :off, :push_previous, :restart, :on]
task :production_migrations => [:set_production_app, :push, :off, :migrate, :restart, :on, :tag]
task :production_rollback => [:set_production_app, :off, :push_previous, :restart, :on]
task :set_staging_app do
APP = STAGING_APP
end
task :set_production_app do
APP = PRODUCTION_APP
end
task :push do
puts 'Deploying site to Heroku ...'
puts `git push -f git@heroku.com:#{APP}.git`
end
task :restart do
puts 'Restarting app servers ...'
puts `heroku restart --app #{APP}`
end
task :tag do
release_name = "#{APP}_release-#{Time.now.utc.strftime("%Y%m%d%H%M%S")}"
puts "Tagging release as '#{release_name}'"
puts `git tag -a #{release_name} -m 'Tagged release'`
puts `git push --tags git@heroku.com:#{APP}.git`
end
task :migrate do
puts 'Running database migrations ...'
puts `heroku rake db:migrate --app #{APP}`
end
task :off do
puts 'Putting the app into maintenance mode ...'
puts `heroku maintenance:on --app #{APP}`
end
task :on do
puts 'Taking the app out of maintenance mode ...'
puts `heroku maintenance:off --app #{APP}`
end
task :push_previous do
prefix = "#{APP}_release-"
releases = `git tag`.split("\n").select { |t| t[0..prefix.length-1] == prefix }.sort
current_release = releases.last
previous_release = releases[-2] if releases.length >= 2
if previous_release
puts "Rolling back to '#{previous_release}' ..."
puts "Checking out '#{previous_release}' in a new branch on local git repo ..."
puts `git checkout #{previous_release}`
puts `git checkout -b #{previous_release}`
puts "Removing tagged version '#{previous_release}' (now transformed in branch) ..."
puts `git tag -d #{previous_release}`
puts `git push git@heroku.com:#{APP}.git :refs/tags/#{previous_release}`
puts "Pushing '#{previous_release}' to Heroku master ..."
puts `git push git@heroku.com:#{APP}.git +#{previous_release}:master --force`
puts "Deleting rollbacked release '#{current_release}' ..."
puts `git tag -d #{current_release}`
puts `git push git@heroku.com:#{APP}.git :refs/tags/#{current_release}`
puts "Retagging release '#{previous_release}' in case to repeat this process (other rollbacks)..."
puts `git tag -a #{previous_release} -m 'Tagged release'`
puts `git push --tags git@heroku.com:#{APP}.git`
puts "Turning local repo checked out on master ..."
puts `git checkout master`
puts 'All done!'
else
puts "No release tags found - can't roll back!"
puts releases
end
end
end
@idris
Copy link

idris commented Nov 9, 2010

You don't need to restart manually after a push, nor do you need to turn on/off maintenance mode. Heroku will auto-restart your app servers upon deploy.

@njvitto
Copy link
Author

njvitto commented Nov 9, 2010

The problem is that you can have a lag beetwen the time of code pushed/server restarted and the migration executed (so for some seconds there can be some users navigating parts of your app with the new code that requires new data structure giving 500 errors).

@toastkid
Copy link

toastkid commented Jun 8, 2011

Got, and used. Great stuff.

@njvitto
Copy link
Author

njvitto commented Jun 8, 2011 via email

@jksilliman
Copy link

Shouldn't you turn off the app before the push, since the push will have code that requires the new schema?

@njvitto
Copy link
Author

njvitto commented Jun 20, 2011 via email

@walteryu
Copy link

walteryu commented Jul 2, 2011

Thanks for sharing, I looked at the heroku_san gem and release management add-on but this seems to be the most elegant solution.

@leoromanovsky
Copy link

Do you use the task :deploy_staging or deploy:staging_migrations ?

@jksilliman
Copy link

jksilliman commented Oct 4, 2011 via email

@njvitto
Copy link
Author

njvitto commented Oct 5, 2011

Yes it's safer and faster to generally use the :deploy_staging task if you haven't new migrations or if the code is backward compatible.
So use the deploy:staging_migrations only if you have new migrations to run.

@jksilliman
Copy link

jksilliman commented Oct 5, 2011 via email

@njvitto
Copy link
Author

njvitto commented Oct 5, 2011

Anyone is really welcome to upgrade the script :)
Anyway is not a problem to run deploy:staging_migrations at every deploy if you are afraid to forget the migrations...

@cj
Copy link

cj commented Dec 19, 2011

Is there a reason you put the app into maintenance mode when pushing?

@toastkid
Copy link

@jksilliman - i think you could test if the migrations have changed by doing

if `git diff origin/HEAD HEAD`.include?("/db/migrate/")

and then decide whether you wanted to put it into maintenance mode during the push.

@njvitto
Copy link
Author

njvitto commented Dec 20, 2011

Hi cj, no it isn't and you haven't (if you see the deploy_staging and deploy_production tasks, they are without migrations).
As for the process to deploy the code I think that the safest way is something like this:

  1. Commit/Push your safe code on git/Github DEVELOP (after merging from a specific branch, if needed) with only the migrations that will be subsequently useful
  2. Deploy (without migrations) on Heroku STAGING your safe code with only the migrations that will be subsequently useful. You can use this script on the root:

"rake deploy_staging"

  1. Run heroku rake db:migrate on STAGING

  2. Commit/Push your safe code on git/Github MASTER (after merging from DEVELOP branch) with only the migrations that will be subsequently useful

  3. Deploy (without migrations) on Heroku PRODUCTION your safe code with only the migrations that will be subsequently useful. You can use this script on the root:

"rake deploy_production"

  1. Run heroku rake db:migrate on PRODUCTION (WARNING: for critical migrations, such as ALTER TABLE, please consider to start an "Heroku Follower", as rollback in bad cases and to drop after the migration was run)

  2. Back to the code: now is the moment to commit/push on git/Github DEVELOP the new code that uses the new migrations

  3. Deploy (without migrations) on Heroku STAGING your safe code that uses the new migrations run in step 3

  4. Commit/Push your safe code on git/Github MASTER (after merging from DEVELOP branch) the new code that uses the new migrations

  5. Deploy (without migrations) on Heroku PRODUCTION your safe code that uses the new migrations run in step 6

Please note that this process is safe in every moment. For instance:

  • There isn't any kind of downtime deploying code that must use new migrations (waiting for rake timing of running or that heroku restarts the servers)
  • If another developer pushes new code all should be good

Hope this helps..

Bye,
Nicola.

@sheldonh
Copy link

For the Cedar stack, you need to modify the deploy:migrate task as follows:

task :migrate do
puts 'Running database migrations ...'
puts heroku run rake db:migrate --app #{APP}
end

Note the word run inserted between "heroku" and "rake".

@bennibu
Copy link

bennibu commented May 30, 2012

Hey, thanks for the nice gist.

I stumbled upon a problem with new bundler 1.2.0.pre. (I'm using rbenv for ruby 1.9.3 installing). When I try the run heroku commands from within the rake task, I got an bundler error: our Ruby version is 1.9.2, but your Gemfile specified 1.9.3.

I know, that is not problem specific to this gist, but maybe you have an idea to solve this?

Best,
benni

@wheeyls
Copy link

wheeyls commented Sep 9, 2012

Very convenient, thanks for sharing!

@teriiehina
Copy link

thank you :)

@djburdick
Copy link

nice gist! there's a rollback feature in heroku (maybe this is new). heroku rollback --app app_name, so you don't actually need to tag the releases yourself now. heroku releases --app app_name

@djburdick
Copy link

here are my mods if you're curious: https://gist.github.com/4410411

@misner
Copy link

misner commented May 9, 2013

I try running heroku run rake deploy but i get an error on my app:
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/task_manager.rb:49:in []' /app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:142:ininvoke_task'
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:101:in block (2 levels) in top_level' /app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:101:ineach'
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:101:in block in top_level' /app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:110:inrun_with_threads'
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:95:in top_level' /app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:73:inblock in run'
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:160:in standard_exception_handling' /app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/lib/rake/application.rb:70:inrun'
/app/vendor/bundle/ruby/1.9.1/gems/rake-10.0.4/bin/rake:33:in <top (required)>' /app/vendor/bundle/ruby/1.9.1/bin/rake:19:inload'
/app/vendor/bundle/ruby/1.9.1/bin/rake:19:in `

'
Would you know what should I do to fix this ?

@jphenow
Copy link

jphenow commented Jun 2, 2013

Made a few abstractions, additions, protections https://gist.github.com/jphenow/5694169

@jfeaver
Copy link

jfeaver commented Mar 27, 2014

Extracting the tasks into a class for easier extension:

https://gist.github.com/jfeaver/9820478

Thanks for the great foundation work @njvitto!

@J3RN
Copy link

J3RN commented Jul 29, 2014

I added Rspec testing, improved Heroku toolbelt support, and post-deploy rake task running on my fork.

@toncid
Copy link

toncid commented Jan 15, 2015

Great task! :)

A interesting thing happened the other day while I was using it to deploy code and run migrations.

Heroku Toolbelt detected that there is an update available and started updating itself in the middle of a running task. This resulted in maintenance mode being turned on, code being deployed and all other tasks cancelled because of the "update in progress" status. This left the environment down and its DB "unmigrated".

I recommend adding another task that is run first:

  task :update_toolbelt do
    puts 'Checking for Heroku Toolbelt updates ...'
    puts `heroku update`
    puts `heroku plugins:update`
  end

And you probably want to run it first when deploying to production. For example:

task :deploy_production => ['deploy:update_toolbelt', 'deploy:set_production_app', 'deploy:push', 'deploy:restart', 'deploy:tag']

namespace :deploy do
  ...
  task :production_migrations => [:update_toolbelt, :set_production_app, :push, :off, :migrate, :restart, :on, :tag]

Hope this helps!

EDIT: Added the plugin update check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment