Travis CIを使ってHerokuへのデプロイを自動化する

2013/09/25

継続的インテグレーションができるようになったのなら、あとは継続的デプロイメントまでやっていただきたいし、大切なのは倍返しじゃなくて繰り返しだねってことで表題の通り。

前にやろうとして調べた時は、HerokuのAPIキーを暗号化して自前でデプロイ用スクリプトを用意して…てな感じでややこしそうだったけど、今はTravis CIで正式に対応していて、コマンド一発で設定できてしまう簡単さで、驚きのあまり出向しそうになった。

The Travis CI Blog: Introducing Continuous Deployment to Heroku

HipChatに通知を送る時にも使ったtravis gemからその設定を行える。

$ travis setup heroku
Deploy only from ruedap/daplog? |yes| yes
Encrypt API key? |yes| yes

travis setup herokuを実行すると色々質問されるので、適当に答えれば設定が完了する。設定の追加で更新された.travis.ymlをプッシュするだけでデプロイまで行ってくれるようになる。さらに複雑な設定を行いたい場合は以下のドキュメントに色々と書かれている。

Travis CI: Heroku Deployment

自分の場合は、このブログもHerokuで運用していて、実際に上記の継続的デプロイな方法を使っているけど、デフォルトの設定から少し付け足して、以下のように2つのブランチを使って本番環境とステージング環境それぞれに自動でデプロイするように設定している。

stagingブランチからPull Requestを送った時は、Herokuのステージング環境にデプロイする
masterブランチにマージ（コミット）した時は、Herokuの本番環境にデプロイする
上記以外のブランチをリモートにプッシュした時は、デプロイは行わない
デプロイを行った時は、その後に指定のRakeタスクを実行する

これらの方針を設定した.travis.ymlのデプロイ部分は以下のような感じ。

deploy:
  provider: heroku
  api_key:
    secure: (snip)
  app:
    master: daplog
    staging: daplog-staging
  on:
    rvm: 2.0.0
  run:
  - rake redis:rebuild

上記のYAMLファイルの全体はここにあるけど、このように設定することで、ヒューマンによる手動オペレーションは基本的にはリモート(GitHub)にPull Requestを送る部分だけで、あとはTravis CIが自動でテストと、ブランチがstagingならステージング環境へのデプロイもやってくれる。そのステージング環境を目視でひと通りチェックして問題が無ければ、GitHub上のマージボタンをポチッと押してmasterにマージすると再度テストが走り、無事に通過すればそのまま本番環境へのデプロイまでが自動で行われる。Oh..fantastic!

個人レベルのアプリ開発で、こんなハイテクな環境を無料でしかも超簡単な設定で使わせてもらえるとは、うっかり土下座しちゃいそうな嬉しさですね。

環境変数

そんな感じで未来感を味わえるTravis & Herokuの素敵な継続的デプロイ機能なんだけど、まだよく分かってないところがあっていくつかハマり中。

今まで手動で直接Herokuに向けてgit push heroku masterしていた時は動いていたのに、Travis CIからの自動デプロイに切り替えたら動かなくなった部分がチラホラあって、そのほとんどがassets precompile時の環境変数がらみっぽい。

まず、Sentryというアプリのエラーを検知して通知してくれるサービスがあり、Herokuのアドオンにもなっているので利用してて、導入すると環境変数のSENTRY_DSNにURLが入って、initializerでそれを参照して設定するようになっているんだけど、Travis CI上ではこれが空になってしまっていてデプロイが失敗する模様。

このあたりのTravisのログが該当部分で、じゃあ同じ環境変数をTravis上でも設定してあげればいいのかなと、travis encryptコマンドを使って前述の環境変数とその値を暗号化した上で.travis.ymlに設定してみたけど、ここで設定した環境変数はテスト実行時は参照できるけど、デプロイ時はできない(?)みたいで、何度か設定の仕方を変えてやってみたけどうまく受け渡せなくてこの方法では改善できなかった。かといって、他にどうすればいいか思いつかなくて、剣道場で汗を流しながら考え中。

似たような問題として、precompile時に環境変数RAILS_ENVを参照して分岐する処理を書いている部分があって、デプロイ時はテスト時と違ってこの値にはproductionが入っているようで、前述のように自分はstaging環境にもデプロイしているので、その時はこの環境変数にはstagingが入ってて欲しくて、どうにかしようとしたんだけど、これもちょっと試行錯誤してみたけど同じようにうまく出来なかったので剣道場(ry

今はどちらも、Travisからデプロイするようになってからは正常に動作させられてないので外してあるけど、このあたりの設定や対応方法がわかれば元に戻したいところ。もしこれについて何か知ってる人がいればぜひ情報求む、大和田常務。