godep を使用した Go の依存関係

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

This article is a work in progress, or documents a feature that is not yet released to all users. This article is unlisted. Only those with the link can access it.

godep の維持管理は終了しました。Heroku での godep サポートは廃止され、2025 年 3 月 1 日に削除されます。Heroku では、代わりに Go モジュール​を使用することをお勧めします。godep ベースのアプリケーションがある場合は、できるだけ早く Go モジュールに移植してください。

このガイドでは、godep​ を使用して Go アプリケーションの依存関係を指定するための Heroku のサポートを完全に利用する方法の概要について説明します。

godep は、アプリケーションの依存関係をそのソースリポジトリにベンダリングすることにより、繰り返し可能なビルドを有効にし、外部のビルド依存関係を削減するツールです。

godep の使用

godep のインストール/更新:

$ go get -u github.com/tools/godep

godep に判定させるには、アプリケーションの依存関係を保存して書き換え、$GOPATH​ 内のアプリケーションのディレクトリに移動して、次のコマンドを実行します。

$ godep save ./...

これには、次の効果があります。

  1. アプリケーションの依存関係の JSON 表現、作業対象のパッケージ (パッケージ仕様)、ローカルで使用しているバージョンの Go を含む Godeps/Godeps.json​ ファイルが作成されます。
  2. 各依存関係が vendor/​ のサブディレクトリにコピーされます。

これらの変更を、次のようにアプリケーションの Git リポジトリにコミットする必要があります。

$ git add -A .
$ git commit -m "Vendoring dependencies"

この Godeps/Godeps.json​ ファイルは、アプリケーションをコンパイルするときに使用する Go のバージョンを決定するために Heroku の Go buildpack によって使用されます。このため、外部の依存関係がないアプリケーションに対しても godep save ./...​ を実行します。

新しい依存関係の追加

  1. 新しい依存関係を go get​ します。
  2. アプリケーションのソースコードを編集して、新しい依存関係をインポートします。
  3. godep save ./...​ を実行して Godeps/Godeps.json​ を更新し、依存関係のソースを vendor/​ にコピーします。

既存の依存関係の更新

  1. go get -u <dependency>​ のようなコードを使用して、イベントを表す sObject を作成して適切なエンドポイントに POST します。
  2. godep update <dependency>​ のようなコードを使用して、イベントを表す sObject を作成して適切なエンドポイントに POST します。
  3. git diff​ (または同様のコマンド) で変更を検査します。
  4. git add -A .; git commit -m "Update <dependency>"​ で変更をコミットします。

アプリケーションをビルドするために使用される Go のバージョンの変更

Go ツールチェーンのメジャーバージョンは Godeps/Godeps.json​ ファイルの GoVersion​ キーに記録されており、go​ で始まります

{
  "ImportPath": "github.com/heroku/go-getting-started",
  "GoVersion": "go1.6",
...
}

このバージョンは、次の 2 つの方法のどちらかで変更できます。

  1. 新しい Go のメジャーバージョンをローカルにインストールして使用した後、godep update -goversion​ を実行します。これにより、使用している Go のバージョンに基づいて Godeps/Godeps.json​ ファイルが調整されます。

  2. Godeps/Godeps.json​ 内の GoVersion​ の値を有効な Go のメジャーバージョンに手動で変更します (go version​ を参照)。

その後、変更をコミットし、アプリを Heroku にプッシュすると、新しく指定された Go のメジャーバージョンの現在のバージョンでアプリケーションが再コンパイルされます。

Go の特定のマイナーバージョンの指定

godep では、Go ツールチェーンのメジャーバージョンのみが (たとえば、go1.6.2​ ではなく go1.6​ が) 記録されます。プッシュのたびに、Heroku は、ツールチェーンの最新のサポートされているマイナーバージョンを使用してアプリケーションをコンパイルします。これが推奨される設定です。ただし、特定のマイナーリビジョンが必要な場合は、Godeps/Godeps.json​ ファイルの GoVersion​ フィールドで完全なマイナーバージョンを指定することによってそれを実現できます。

Go の開発バージョンの使用

Go の開発バージョンが必要な場合は、Godeps/Godeps.json​ ファイルの GoVersion​ フィールドを devel-<short sha>​ に設定できます。この <short-sha>​ は、Heroku が使用するコミットの短い git SHA に置き換えます。次のプッシュで、Heroku は Github から Go のそのリビジョンを取得してコンパイルし、そのバージョンを使用してアプリケーションをビルドします。

vendor/ ディレクトリを使用した Godep ワークスペースから go1.6 への移行

  • go1.6 を使用していることを確認します (go version​)。
  • 最新の godep があることを確認します (go get -u github.com/tools/godep​)。
  • godep restore​ を実行して、プロジェクトの依存関係が $GOPATH​ に確実に “復元される” ようにします。
  • 書き換えを使用している場合は、godep save -r=false <pkg spec>​ を実行してそれを削除します。
  • rm -rf Godeps​ を実行して、古い依存関係情報を削除します。
  • godep save <pkg spec>​ を実行して、deps を vendor/​ に再保存します。
  • git add -A; git commit -am "Upgrade to go1.6"​ を実行して、変更をリポジトリにコミットします。
  • git push heroku master​ を実行して、go1.6 と vendor/​ ディレクトリを使用してデプロイします。

何か問題が発生した場合は、サポートチケット​を提出してください。トラブルシューティングするときは、上記の手順の出力が最も役立ちます。