Heroku のデプロイ用にコードベースを準備する

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2024年05月08日(水)

Heroku プラットフォームでは、とても柔軟にプログラミング言語、アプリケーションフレームワーク、およびコードの組織を選択することができます。ただし、各 Heroku アプリで従う必要がある規則がいくつかあります。

Heroku にデプロイする既存のコードベースがある場合は、最初の Heroku のデプロイが成功するように、以下の変更を行います。

この記事では、すでに Heroku アカウントを作成​済みで、Heroku CLI をインストール​済みであることを前提としています。

1. Git リポジトリでコードベースを追跡する

Heroku のビルドシステムでは、一般によく使われているバージョン管理システムである Git を使用しています。したがって、デプロイするためにはコードベースが Git リポジトリにコミットされている必要があります。

すでに別のバージョン管理システムを使用している場合は、そのシステムのドキュメントで、スナップショットを Git にエクスポートする方法を確認してください。

2. Heroku Git リモートを追加する

各 Heroku アプリには Heroku でホストされている独自の Git リポジトリがあります。このリポジトリにコードの変更をプッシュすることで、アプリの新しいバージョンをデプロイします。この作業を行うためには、ローカル​の Git リポジトリが Heroku でホストされている​リポジトリの URL を認識している必要があります。

「​Heroku リモートの作成​」の手順を実行して、Heroku でホストされているリポジトリを Git リモートとして追加します。

Heroku Git はデプロイのための便宜的なものであり、安定した Git リポジトリのためのものではありません。コードベースを追跡するには、GitHub​ (推奨)、GitLab​、BitBucket​ などのバージョン管理システムを使用してください。

3. Procfile を追加する

ファイル拡張子のない​ Procfile​ という名前のテキストファイルをアプリのルートディレクトリにコミットします。このファイルにより、アプリを起動するときに実行するコマンドを Heroku に指定します。これらのコマンドは、多くの場合、ローカルマシンでコードを実行するときに使用するコマンドと同じです。

シンプルな Node.js アプリ用の Procfile​ の例を次に示します。

web: node app.js

上記の例で定義されている web​ プロセスタイプにより、node app.js​ を実行して Web アプリケーションを起動するように Heroku に指定します。web​プロセスタイプは、Web から (つまりアプリのユーザーから) HTTP トラフィックを受信することができる唯一のプロセスタイプであるため特殊です。

Procfile​ の別の行で追加のプロセスタイプを指定できますが、web​ 以外のプロセスタイプは Web トラフィックを受信できません​。プロセスタイプに使用できるのは英数字の文字列です (ハイフンとアンダースコアも使用できます)。

例 (Rails の場合):

web: bundle exec rails server -p $PORT
worker: bundle exec rake jobs:work

選択した言語およびフレームワーク用の Procfile の作成の詳細については、言語固有のガイド​を参照してください。

​Procfile の詳細

4. 正しいポートをリッスンする

ローカルマシンでは、アプリの Web サーバーは、開いていて未予約であれば、どのポートでもリッスンできます。しかし、Heroku では、特定の​ポートをリッスンする必要があります。

この特定のポートは、PORT​ 環境変数で指定されます。Heroku で Web サーバーが起動したら、PORT​ で指定されているポート番号でリッスンしていることを確認します。

app.listen(process.env.PORT);

ローカルマシンで実行する場合に PORT​ 環境変数を設定しなくてもよいようにするには、上記の行を次の行に置き換えます。

let port = process.env.PORT;
if (port == null || port == "") {
  port = 8000;
}
app.listen(port);

この場合、PORT​ 環境変数が設定されていなければ、サーバーはポート 8000​ をリッスンします。

上記の例は、Express を使用するシンプルな Node.js アプリ用です。環境変数の読み込みと特定のポートをリッスンするように Web サーバーを構成する方法の詳細については、プログラミング言語のドキュメントや Heroku の言語固有のガイド​を参照してください。

5. ローカルファイルシステムへの書き込みの代わりにデータベースまたはオブジェクトストレージを使用する

現在、アプリで持続的な保存のためにデータをローカルファイルシステム (ローカルの SQLite データベースを含む) に書き込んでいる場合、Heroku ではそのデータを (ユースケースに応じて) 次のいずれかの場所に書き込むようにする必要があります。

  • マネージドデータベースサービス (Heroku Postgres など)
  • マネージドオブジェクトストレージサービス (Amazon S3 など)

この要件が存在するのは、Heroku の dyno​ (コードを実行する Linux コンテナ) には一時的なファイルシステム​があるためです。アプリの dyno は 1 日に 1 回以上自動的に置き換えられ (これを dyno の再起動)​といいます)、再起動のたびに、アプリでローカルファイルシステムに書き込んだデータは破棄​されます。

最初は、Web アプリのこの「ステートレス」な設計には驚きと困惑を感じることがあるかと思います。背景にある設計論についての詳細を参照​してください。

データベースのプロビジョニング

Heroku Postgres​ は、Heroku のマネージド SQL データベースサービスであり、Heroku アプリの推奨リレーショナルデータベースです。手頃な価格の essential-0​ プランは、比較的小さなアプリを使用し始めたり、Heroku プラットフォームをテストしたりするのに適しています。

Heroku Postgres をプロビジョニングする​方法を確認してから、開発環境と本番環境との間のパリティ (同等性) を保証するためにローカルマシンで Postgres を実行する​方法も確認してください。

Heroku Postgres を使用したくない場合は、ほかのリレーショナルデータベース (MySQL や MongoDB など) 用のアドオンを Heroku Elements Marketplace​ で入手できます。

オブジェクトストレージサービスのプロビジョニング

Heroku で Amazon S3 を使用する方法を参照してください。

S3 バケットを管理するためのアドオンも Heroku Elements Marketplace​ で入手できます。

6. 言語固有の設定を行う

上記の変更は、プログラミング言語に関係なく、すべての Heroku アプリに適用されます。上記の変更に加え、自分のコードベースに対して言語固有の変更が必要な場合があります。

詳細については、ご使用の言語のデプロイに関連する記事を参照してください。

7. アプリをデプロイする

この時点で、アプリは基本的なデプロイができる状態になっていると思われます。デプロイを行う方法については、コードのデプロイ​を参照してください。

8. Heroku プラットフォームを使ってみる

この記事では、Heroku のデプロイのためのコードベースを準備するために必要な最小限の手順を説明しています。Heroku プラットフォームには、以下を含め、シンプルなアプリのデプロイより高度な多くの強力な機能が用意されています。