CodeArtifact をnuget または dotnet CLI で使用する

nuget および dotnet のような CLI ツールを使用して、CodeArtifact からパッケージを公開して消費できます。このドキュメントでは、CLI ツールの設定と、それらを使用してパッケージを公開または使用する方法について説明します。

nuget または dotnet CLI を設定する

AWS CLI を使用して、または手動で、CodeArtifact NuGet 認証情報 プロバイダーを使用して nuget または dotnet CLI を設定できます。セットアップを簡素化し、認証を継続するために、NuGet を認証情報プロバイダーで設定することを強くお勧めします。

方法 1: CodeArtifact NuGet 認証情報プロバイダーを使用して設定する

CodeArtifact NuGet 認証情報プロバイダーは、NuGet CLI ツールを使用した CodeArtifact の認証と設定を簡素化します。CodeArtifact 認証トークンは、最大 12 時間有効です。nuget または dotnet CLI の使用中にトークンを手動で更新する必要がないように、認証情報プロバイダーは現在のトークンの有効期限が切れる前に定期的に新しいトークンを取得します。

CodeArtifact NuGet 認証情報プロバイダーのインストールと設定

dotnet

1. 以下の dotnet コマンドを使用して、NuGet.org の AWS.CodeArtifact.NuGet.CredentialProvider ツールをダウンロードします。

   dotnet tool install -g AWS.CodeArtifact.NuGet.CredentialProvider

2. codeartifact-creds install コマンドを使用して、認証情報プロバイダーを NuGet プラグインフォルダにコピーします。

   dotnet codeartifact-creds install

3. (オプション): 認証情報プロバイダーで使用する AWS プロファイルを設定します。設定されていない場合は、認証情報プロバイダーはデフォルトのプロファイルを使用します。AWS CLI プロファイルの詳細については、名前付きプロファイル を参照してください。

   dotnet codeartifact-creds configure set profile profile_name

nuget

次の手順を実行して、NuGet CLI を使用して Amazon S3 バケットから CodeArtifact NuGet 認証情報プロバイダーをインストールして設定します。認証情報プロバイダーはデフォルト AWS CLI プロファイルを使用します。プロファイルの詳細については、名前付きプロファイル を参照してください。

1. CodeArtifact NuGet 認証情報プロバイダー (codeartifact-nuget-credentialprovider.zip) の最新バージョンを Amazon S3 バケットからダウンロードします。

   以前のバージョンを表示してダウンロードするには、「CodeArtifact NuGet 認証情報プロバイダーのバージョン」を参照してください。

2. ファイルを解凍します。

3. AWS.CodeArtifact.NuGetCredentialProvider フォルダを、netfx フォルダから、Windows の場合は %user_profile%/.nuget/plugins/netfx/、LinuxまたはMacOSの場合は ~/.nuget/plugins/netfx にコピーします。

4. AWS.CodeArtifact.NuGetCredentialProvider フォルダを、netcore フォルダから、Windows の場合 %user_profile%/.nuget/plugins/netcore/ は、LinuxまたはMacOS の場合は ~/.nuget/plugins/netcore にコピーします。

リポジトリを作成して認証情報プロバイダーを設定したら、nuget または dotnet CLI ツールを使用して、パッケージをインストールして公開できます。詳細については、「CodeArtifact から NuGet パッケージを消費する」および「NuGet パッケージを CodeArtifact に公開する」を参照してください。

方法 2: login コマンドで nuget または dotnet を設定する

AWS CLI にある codeartifact login コマンドは、リポジトリエンドポイントと認可トークンを NuGet 設定ファイルに追加し、nuget または dotnet が CodeArtifact リポジトリに接続できるようにします。これにより、Windows の場合は%appdata%\NuGet\NuGet.Config、Mac/Linux の場合は ~/.config/NuGet/NuGet.Config または ~/.nuget/NuGet/NuGet.Config にあるユーザーレベルの NuGet 設定が変更されます。NuGet 設定の詳細については、一般的な NuGet の設定 を参照してください。

login コマンドは次の処理を行います:

login を呼び出した後のデフォルトの認可期間は12時間であり、トークンを定期的に更新するには、login を呼び出す必要があります。login コマンドを使用して作成された認可トークンの詳細については、「loginコマンドで作成されたトークン」を参照してください。

リポジトリを作成して認証を設定したら、nuget、dotnet または msbuild パッケージを使用して、CLI クライアントをインストールして公開できます。詳細については、「CodeArtifact から NuGet パッケージを消費する」および「NuGet パッケージを CodeArtifact に公開する」を参照してください。

方法 3: login コマンドなしで nuget または dotnet を設定する

マニュアル設定の場合、リポジトリエンドポイントと認可)トークンを NuGet 設定ファイルに追加して、nuget または dotnet が CodeArtifact リポジトリに接続できるようにする必要があります。

CodeArtifact リポジトリに接続するには、nuget または dotnet を手動で設定します。

CodeArtifact から NuGet パッケージを消費する

いったん CodeArtifact でNuGetを設定 したら、CodeArtifact リポジトリまたはその上流リポジトリの 1 つに保存されている NuGet パッケージを使用できます。

CodeArtifact リポジトリまたはその上流リポジトリの 1 つからパッケージバージョンを nuget または dotnet で消費するには、次のコマンドを実行し、packageName を消費したいパッケージの名前で置き換え、packageSourceName をNuGet 設定ファイル内の CodeArtifact リポジトリのソース名で置き換えます。login コマンド を使用して NuGet 設定を設定した場合、ソース名は domain_name/repo_name です。

dotnet

dotnet add package packageName --source packageSourceName

nuget

nuget install packageName -Source packageSourceName

パッケージの特定バージョンをインストールするには

dotnet

dotnet add package packageName --version 1.0.0 --source packageSourceName

nuget

nuget install packageName -Version 1.0.0 -Source packageSourceName

詳細については、マイクロソフトドキュメント の nuget.exe CLI を使用してパッケージを管理する または dotnet CLI を使用してパッケージをインストールして管理する を参照してください。

NuGet.org から NuGet パッケージを消費する

NuGet パッケージは、Nuget.org への外部接続を設定することで、CodeArtifact リポジトリを介して Nuget.org から消費できます。Nuget.org から消費されたパッケージは、CodeArtifact リポジトリに取り込まれて保存されます。外部接続の追加方法の詳細については、「CodeArtifact リポジトリをパブリックリポジトリに接続する」を参照してください。

NuGet パッケージを CodeArtifact に公開する

いったん CodeArtifact で NuGet を設定 すると、nuget または dotnet を使用して CodeArtifact リポジトリにパッケージバージョンを公開できます。

パッケージバージョンを CodeArtifact リポジトリにプッシュするには、次のコマンドを、NuGet 設定ファイル内の .nupkg ファイルと CodeArtifact リポジトリのソース名にフルパスで実行します。login コマンドを使用して NuGet 設定を設定した場合、ソース名は domain_name/repo_name です。

dotnet

dotnet nuget push path/to/nupkg/SamplePackage.1.0.0.nupkg --source packageSourceName

nuget

nuget push path/to/nupkg/SamplePackage.1.0.0.nupkg -Source packageSourceName

CodeArtifact NuGet 認証情報プロバイダーの参照

CodeArtifact NuGet 認証情報プロバイダーを使用すると、CodeArtifact リポジトリを使用して NuGet を簡単に設定および認証できます。

CodeArtifact NuGet 認証情報プロバイダーのコマンド

このセクションには、CodeArtifact NuGet 認証情報プロバイダーのコマンドリストが含まれます。これらのコマンドには、次の例のように、dotnet codeartifact-creds でプレフィックスを付ける必要があります。

dotnet codeartifact-creds command

CodeArtifact NuGet 認証情報プロバイダーのログ

CodeArtifact NuGet 認証情報プロバイダーのログを有効にするには、環境でログファイルを設定する必要があります。認証情報プロバイダーのログには、次のような有用なデバッグ情報が含まれています:

CodeArtifact NuGet 認証情報プロバイダーのログファイルを設定する

export AWS_CODEARTIFACT_NUGET_LOGFILE=/path/to/file

ログファイルの設定後、codeartifact-creds コマンドはログ出力をそのファイルの内容に追加します。

CodeArtifact NuGet 認証情報プロバイダーのバージョン

CodeArtifact NuGet 認証情報プロバイダーのバージョン履歴情報とダウンロードリンクを次の表に示します。