Heroku へのデプロイ
このノウハウガイドでは、HerokuにデプロイするためのCircleCIの設定方法を学びます。
はじめに
Heroku は、クラウドでアプリケーションをホスティングするための一般的なプラットフォームです。 アプリケーションを Heroku にデプロイするように CircleCI を設定するには、以下の手順を行います。
Heroku Orb を使用したデプロイ
1. アカウントの作成
Heroku アカウントを作成し、 Heroku の Web ページ に記載された手順に従って、選択した言語でプロジェクトをセットアップします。
2. 環境変数の作成
Heroku アプリケーションの名前と Heroku API キーを、それぞれ環境変数 HEROKU_APP_NAME
と HEROKU_API_KEY
として追加します。 シークレットのマスキング を活用するには、環境変数は プロジェクトレベル で、または コンテキスト 内で設定することをお勧めします。
3. Heroku Orb を使用したデプロイ
Heroku Orb を使って設定を簡単にします。 deploy-via-git
により、Heroku CLI のプライマリコンテナへのインストール、定義した任意のデプロイ前のステップの実行、アプリケーションの実行、そして定義した任意のデプロイ後のステップの実行が行われます。 パラメーターとオプションの詳細については、 Orb レジストリ の Heroku Orb ページを参照してください。
この例では必ずプレースホルダーのバージョンを置き換えてください。
version: 2.1
orbs:
heroku: circleci/heroku@x.y
workflows:
heroku_deploy:
jobs:
- heroku/deploy-via-git:
post-steps:
- run: your-database-migration-command #example of a post-deployment step
pre-steps:
- run: command-that-run-before-deploying #example of a pre-deployment step
Heroku Orb の詳細については、 CircleCI Heroku Orb を参照してください。
2.0 設定を使った Heroku のデプロイ
1. アカウントの作成
Heroku アカウントを作成し、 Heroku の Web ページ に記載された手順に従って、選択した言語でプロジェクトをセットアップします。
2. 環境変数の作成
Heroku アプリケーションの名前と Heroku API キーを、それぞれ環境変数 HEROKU_APP_NAME
と HEROKU_API_KEY
として追加します。 シークレットのマスキング を活用するには、環境変数は プロジェクトレベル で、または コンテキスト 内で設定することをお勧めします。
3. デプロイジョブの作成
.circleci/config.yml
で、デプロイジョブを作成して Executor タイプ を追加します。
4. デプロイジョブに手順を追加
デプロイジョブに steps
を追加し、コードをチェックアウトし deploy
します。 デプロイしたいブランチを指定します。 この例では、main ブランチを指定し、git push
コマンドを使ってデプロイします。
version: 2
jobs:
build:
...