Go モジュールを管理する

このページでは、Artifact Registry に格納されているパッケージ化された Go モジュールを管理する方法について説明します。

準備

ターゲットリポジトリが存在しない場合は、新しいリポジトリを作成します。リポジトリ形式として Go を選択します。
リポジトリに必要な権限が付与されていることを確認します。
（省略可）gcloud コマンドのデフォルトを構成します。
Go 1.15 以降をインストールします。
package-go-module gcloud CLI アドオンをインストールします。
```
gcloud components install package-go-module
```
Artifact Registry で認証するように Go を構成します。

必要なロール

モジュールの管理に必要な権限を取得するには、リポジトリに対する次の IAM ロールの付与を管理者に依頼してください。

モジュールの表示: Artifact Registry 閲覧者（roles/artifactregistry.reader）
モジュールをダウンロードまたはインストールする: Artifact Registry 閲覧者（roles/artifactregistry.reader）
リポジトリにモジュールを追加する: Artifact Registry ライター（roles/artifactregistry.writer）
モジュールを削除する: Artifact Registry リポジトリ管理者（roles/artifactregistry.repoAdmin）

ロールの付与の詳細については、アクセスの管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

モジュールをアップロードする

リポジトリモード: 標準

モジュールをパッケージ化してリポジトリにアップロードするには、次のコマンドを実行します。

  gcloud artifacts go upload --project=PROJECT \
      --repository=REPOSITORY \
      --location=LOCATION \
      --module-path=MODULE_PATH \
      --version=VERSION \
      --source=SOURCE_LOCATION

以下を置き換えます。

PROJECT は、Google Cloud プロジェクト ID に置き換えます。
REPOSITORY は、パッケージが保存されるリポジトリの名前に置き換えます。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションに置き換えます。
MODULE_PATH は、モジュールパスに置き換えます。例: example.com/foo。詳細については、Go モジュールリファレンスをご覧ください。
VERSION は、vX.Y.Z 形式のモジュールのセマンティックバージョンに置き換えます。ここで、X はメジャーバージョン、Y はマイナーバージョン、Z はパッチバージョンです。
SOURCE_LOCATION は、Go モジュールのルートディレクトリへのパスに置き換えます。--source フラグを省略した場合のデフォルト値は現在のディレクトリです。

モジュールが Artifact Registry にアップロードされます。

Go モジュールの作成方法について詳しくは、こちらのチュートリアルをご覧ください。

新しいモジュールバージョンをアップロードする

リポジトリモード: 標準

デフォルト値が構成されているときに、新しいバージョンのモジュールをデフォルトのプロジェクト、リポジトリ、ロケーションにアップロードするには、新しいバージョン番号で次のコマンドを実行します。

  gcloud artifacts go upload \
      --module-path=MODULE_PATH \
      --version=VERSION \
      --source=SOURCE_LOCATION

VERSION は、更新されたモジュールのバージョンに置き換えます。たとえば、パスが example.com/foo のモジュールのバージョン 0.1.1 をアップロードするには、次のコマンドを実行します。

  gcloud artifacts go upload \
      --module-path=example.com/foo \
      --version=v0.1.1 \
      --source=SOURCE_LOCATION

モジュールをプレリリース版としてマークするには、VERSION の後にダッシュを追加し、モジュールのプレリリース識別子を追加します。

  gcloud artifacts go upload \
      --module-path=MODULE_PATH \
      --version=VERSION-PRE_RELEASE_IDENTIFIERS \
      --source=SOURCE_LOCATION

PRE_RELEASE_IDENTIFIERS は、ドット区切りの ASCII 英数字とハイフンに置き換えます。たとえば、パス example.com/foo モジュールで alpha.x.12m.5 によって識別されるモジュールのプレリリースをアップロードするには、次のコマンドを実行します。

  gcloud artifacts go upload \
      --module-path=example.com/foo \
      --version=v1.0.0-alpha.x.12m.5 \
      --source=SOURCE_LOCATION

新しいメジャーバージョンをアップロードする

リポジトリモード: 標準

メジャーバージョンには、以前のバージョンとの下位互換性がありません。互換性を破る変更をインポートしないようにするには、v1 以降のメジャーバージョンに、以前のバージョンとは異なるモジュールパスを設定する必要があります。v2 から、メジャーバージョンはモジュールパスの末尾に追加されます。

たとえば、example.com/foo の v2.0.0 のモジュールパスは example.com/foo/v2 になります。

v1 より後のメジャーバージョンは、メジャーバージョンのサフィックスが付いた名前の別のディレクトリに開発することをおすすめします。

デフォルト値が構成されているときに、パスが example.com/foo であるモジュールの新しいメジャーバージョン 2.0.0 をデフォルトのプロジェクト、リポジトリ、ロケーションにアップロードするには、次のようにします。

  gcloud artifacts go upload --module-path=example.com/foo/v2 --version=v2.0.0

モジュールを一覧表示する

リポジトリモード: 標準

次のコマンドを実行して、デフォルト値が構成されているときに、デフォルトのプロジェクト、リポジトリ、ロケーションにあるアップロードされた Go モジュールを検査します。

  gcloud artifacts packages list

出力は次のようになります。

  Listing items under project my-project, location us-west1, repository my-repo.

  PACKAGE                   CREATE_TIME          UPDATE_TIME
  example.com/foo           2022-06-03T20:43:39  2022-06-20T20:37:40

モジュールバージョンの詳細を表示する

リポジトリモード: 標準

デフォルト値が構成されているときに、次のコマンドを実行して、デフォルトのプロジェクト、リポジトリ、ロケーションにあるモジュールのバージョンを表示します。

  gcloud artifacts versions list --package=MODULE_PATH

出力は次のようになります。

  Listing items under project my-project, location us-west1, repository my-repo, package example.com/foo.

  VERSION  DESCRIPTION  CREATE_TIME          UPDATE_TIME
  v0.1.0                2022-06-03T20:43:39  2022-06-03T20:43:39
  v0.1.1                2022-06-20T20:37:40  2022-06-20T20:37:40

モジュールを依存関係として使用する

リポジトリモード: 標準

Artifact Registry に格納されているモジュールをインポートするには、Go で Artifact Registry から依存関係を探し、チェックサムデータベースをバイパスするように指示する必要があります。Go の認証を設定するの手順に従って、認証と Go 環境を設定します。

Artifact Registry の認証に有効期間の短い認証情報を使用している場合は、次のコマンドを実行して OAuth トークンを更新する必要があります。
```
  GOPROXY=proxy.golang.org \
  go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@latest refresh
```
モジュールにまだ go.mod ファイルがない場合は、ディレクトリをモジュールのフォルダに変更し、go mod init を実行してパッケージの go.mod ファイルを作成します。
```
  go mod init MODULE_PATH
```
MODULE_PATH は、Artifact Registry に保存されているモジュールのモジュールパスに置き換えます。詳細については、Go モジュールのリファレンスをご覧ください。
Artifact Registry に格納されているモジュールのバージョンを要求するには、go.mod ファイルを次のように編集します。
```
module example.com/bar

go 1.19

require example.com/foo v0.1.0
```
以下を置き換えます。
- example.com/foo は、必要なモジュールのモジュールパスです
- v0.1.0 は Artifact Registry に保存されているバージョンです
main.go ファイルの import セクションに、通常どおりモジュールパスを含めます。

たとえば、パス example.com/foo が Artifact Registry に格納されているモジュールをインポートする場合、インポートセクションは次のようになります。
```
  
  package main

  import (
    foo "example.com/foo"
  )

  func main() {

    ...

  }

  
```
go mod tidy を実行して依存関係をダウンロードします。
```
  go mod tidy
```
モジュールを通常どおり実行します。
```
  go run .
```
Artifact Registry に格納されているモジュールが依存関係としてダウンロードされ、使用されます。

パッケージ化された Go モジュールを削除する

リポジトリモード: 標準

パッケージとそのすべてのバージョンを削除することや、特定のバージョンを削除することができます。

パッケージを削除すると、その操作は元に戻せません。

パッケージまたはパッケージのバージョンを削除する前に、そのパッケージの重要な依存関係を送信済み、または対処済みであることを確認してください。

パッケージを削除するには：

コンソール

Google Cloud Console で [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストで、適切なリポジトリをクリックします。

[パッケージ] ページに、リポジトリ内のパッケージが一覧表示されます。
削除するパッケージを選択します。
[削除] をクリックします。
確認のダイアログボックスで、[削除] をクリックします。

gcloud

次のコマンドを実行します。

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Where

PACKAGE は、リポジトリ内のパッケージの名前です。
REPOSITORY はリポジトリの名前です。デフォルトリポジトリを構成した場合は、このフラグを省略してデフォルトを使用できます。
LOCATION は、リージョンまたはマルチリージョンのロケーションです。このフラグを使用して、特定のロケーションのリポジトリを表示します。デフォルトロケーションを構成している場合は、このフラグを省略してデフォルトを使用できます。
--async - 処理中のオペレーションの完了を待たずに、直ちにコマンドを終了します。

パッケージのバージョンを削除するには:

コンソール

Google Cloud Console で [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストで、適切なリポジトリをクリックします。

[パッケージ] ページに、リポジトリ内のパッケージが一覧表示されます。
パッケージをクリックして、そのパッケージのバージョンを表示します。
削除するバージョンを選択します。
[削除] をクリックします。
確認のダイアログボックスで、[削除] をクリックします。

gcloud

次のコマンドを実行します。

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Where

PACKAGE は、リポジトリ内のパッケージの名前です。
REPOSITORY はリポジトリの名前です。デフォルトリポジトリを構成した場合は、このフラグを省略してデフォルトを使用できます。
LOCATION は、リージョンまたはマルチリージョンのロケーションです。このフラグを使用して、特定のロケーションのリポジトリを表示します。デフォルトロケーションを構成している場合は、このフラグを省略してデフォルトを使用できます。
--async は処理中のオペレーションの完了を待たずに、直ちにコマンドを終了します。

次のステップ

Go Quickstartを試す。
Go コマンドを使わずに、モジュールまたはバージョンに関連付けられた個々のファイルをダウンロードする。

Go モジュールを管理する

準備

必要なロール

モジュールをアップロードする

新しいモジュール バージョンをアップロードする

新しいメジャー バージョンをアップロードする

モジュールを一覧表示する

モジュール バージョンの詳細を表示する

モジュールを依存関係として使用する

パッケージ化された Go モジュールを削除する

コンソール

gcloud

コンソール

gcloud

次のステップ

新しいモジュールバージョンをアップロードする

新しいメジャーバージョンをアップロードする

モジュールバージョンの詳細を表示する