Heroku sbt プラグインを使用した Scala および Play アプリケーションのデプロイ

最終更新日 2020年04月29日(水)

Git デプロイ​に加えて、Heroku は API を介したアプリのビルドおよびリリース​をサポートします。Heroku sbt プラグイン​はこの API を使用して、事前パッケージ済みスタンドアロン Web アプリケーションの直接デプロイを Heroku に提供します。

この方法は、コンパイルに時間がかかったり、Travis CI​ や Jenkins​ などの継続的インテグレーション サーバーからデプロイする必要があったりするアプリケーションにとっては推奨される方法となる場合があります。

この記事では、Heroku sbt プラグインをプロジェクトに組み込んで設定し、アプリケーションを Heroku にデプロイする方法について学びます。

プラグインの追加

プラグインをプロジェクトに組み込むには、project/plugins.sbt​ ファイルに次のコードを追加します。

addSbtPlugin("com.heroku" % "sbt-heroku" % "2.1.4")

Play を使用していない場合、sbt-native-packager​ プラグインを追加する必要もあります。次のコードを project/plugins.sbt​ に追加することによって、この操作を行うことができます。

addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.5.2")

次に、sbt update​ を実行して、新しい依存関係がダウンロードされるようにします。

次に、プラグインのデプロイ先となる Heroku アプリケーションの名前を設定する必要があります。ただし、まず最初に新しいアプリを作成します。Heroku CLI​ をインストールし、create​ コマンドを -n​ フラグを指定して実行することにより、Git リモートの追加が回避されます。

$ heroku create -n
Creating obscure-sierra-7788... done, stack is heroku-18
http://obscure-sierra-7788.herokuapp.com/ | git@heroku.com:obscure-sierra-7788.git

次に、以下のようなコードを build.sbt​ に追加しますが、"obscure-sierra-7788" は、作成したアプリケーションの名前に置き換えます。

herokuAppName in Compile := "obscure-sierra-7788"

これでデプロイできます。

プラグインを使用したデプロイ

slug を作成してこれを Heroku にデプロイするには、次のコマンドを実行します。

$ sbt stage deployHeroku
...
[info] -----> Packaging application...
[info]        - app: obscure-sierra-7788
[info]        - including: target/universal/stage/
[info] -----> Creating build...
[info]        - file: target/heroku/build.tgz
[info]        - size: 47MB
[info] -----> Uploading slug... (100%)
[info]        - success
[info] -----> Deploying...
[info] remote:
[info] remote: -----> sbt-heroku app detected
[info] remote: -----> Installing JDK 11... done
[info] remote: -----> Discovering process types
[info] remote:        Procfile declares types -> console, web
[info] remote:
[info] remote: -----> Compressing...
[info] remote:        Done: 106.5M
[info] remote: -----> Launching...
[info] remote:        Released v3
[info] remote:        https://obscure-sierra-7788.herokuapp.com/ deployed to Heroku
[info] remote:
[info] -----> Done
[success] Total time: 113 s (01:53), completed Jan 17, 2020 11:39:21 AM

次のコマンドを使用して、アプリケーションにアクセスします。

$ heroku open -a obscure-sierra-7788

または、次のコマンドでログを表示します。

$ heroku logs -a obscure-sierra-7788

Heroku CLI によってユーザーは、アプリケーションへのアクセスが可能になり、git push​ でデプロイされたアプリケーションのようにコマンドを実行できるようになります。

高度な設定

sbt プラグインではいくつかの高度な設定を行うことができます。これらすべての設定は、build.sbt​ ファイルに定義されます。たとえば、目的の JDK バージョンを次のように設定できます。

herokuJdkVersion in Compile := "11"

サポートされている JDK バージョンについては、『Heroku Java サポート​』を参照してください。

設定変数を Map​ として設定できます。

herokuConfigVars in Compile := Map(
  "MY_VAR" -> "some value",
  "JAVA_OPTS" -> "-Xmx384m -Xss512k -XX:+UseCompressedOops"
)

herokuConfigVars​ に定義されるすべての変数は、デフォルトまたは以前定義された環境設定を上書きすることに注意してください。

プロセスタイプ (Procfile​ のようなもの) を herokuProcessTypes​ で設定できます。

herokuProcessTypes in Compile := Map(
  "web" -> "target/universal/stage/bin/my-app -Dhttp.port=$PORT",
  "worker" -> "java -jar target/universal/stage/lib/my-worker.jar"
)

最後に、次のように slug に追加のディレクトリを含めることができます (プロジェクトルートを基準とした相対ディレクトリである必要があります)。

herokuIncludePaths in Compile := Seq(
  "app", "conf/routes", "public/javascripts"
)

デフォルトでは、プラグインは不可欠のディレクトリをプロジェクトの target​ ディレクトリの下にパッケージ化するため、追加のディレクトリを組み込むことは、ほとんどの場合は必要ありません。

複数のアプリケーションへのデプロイ

ほとんどの実際のアプリケーションは、複数の Heroku アプリ (開発、テスト、本番など) へのデプロイが必要です。通常の場合、これは複数の Git リモートで実行されます。ただし、プラグインを使用すると、システムプロパティ、環境変数、または他のネイティブの sbt/Java 設定方法を使用できます。たとえば、次のように herokuAppName​ を Map で定義し、システムプロパティに関する値を選択することができます。

herokuAppName in Compile := Map(
  "test"  -> "your-heroku-app-test",
  "stage" -> "your-heroku-app-stage",
  "prod"  -> "your-heroku-app-prod"
).getOrElse(sys.props("appEnv"), "your-heroku-app-dev")

その後、次のように sbt コマンドを実行します。

$ sbt -DappEnv=test stage deployHeroku

要件

プラグインには考慮すべきいくつかの制約があります。

  • プロジェクトでは sbt 0.13.5 以降を使用する必要があります。

  • Java 1.7 以上をローカルで使用する必要があります。

  • プラグインは Play 2.0 または 2.1 をサポートしません。

プラグインおよび Scala 全般についての詳細は、『Heroku の Scala サポート​』を参照してください。sbt についての詳細は、sbt のドキュメント​を参照してください。