npm プロジェクトを Azure Artifacts フィードに接続する

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Azure Artifacts を使用すると、開発者はフィードや npmjs.com などのパブリック レジストリからさまざまなパッケージの種類を発行してインストールできます。 Azure Artifacts で認証するには、npm 構成ファイルを構成する必要があります。 このファイルには、npm で使用されるフィード URL と資格情報が含まれており、プロキシの設定、既定のパッケージの場所の定義、プライベート パッケージ フィードの構成など、npm クライアントの動作をカスタマイズするためのオプションが提供されます。 .npmrc ファイルは通常、ユーザーのホーム ディレクトリにありますが、プロジェクト レベルで作成して既定の設定をオーバーライドすることもできます。 .npmrc ファイルを変更することで、ユーザーは特定の要件を満たすように npm エクスペリエンスをカスタマイズできます。

前提条件

• Azure DevOps organizationとプロジェクト。 まだ作成していない場合は、organizationまたはプロジェクトを作成します。

• Azure Artifacts フィード。 まだお持ちでない場合は、新しいフィードを作成できます。

• Node.jsと npm をダウンロードしてインストールします。

プロジェクトの設定

ベスト プラクティスについては、2 つの個別の構成ファイルを使用することをお勧めします。 1 つ目は Azure Artifacts での認証に使用され、2 つ目はローカルに格納され、資格情報が保持されます。

2 番目のファイルを設定するには、開発用コンピューターのホーム ディレクトリに配置し、すべてのレジストリ資格情報を含めるだけです。 これにより、npm クライアントは認証のために資格情報に簡単にアクセスでき、資格情報をセキュリティで保護しながら構成ファイルを共有できます。

次の手順では、最初の構成ファイルを設定する手順について説明します。

Windows

1. Azure DevOps 組織にサインインしてから、プロジェクトに移動します。

2. [成果物] を選択し、[フィードに接続] を選択します。

   

3. 左側のナビゲーション ウィンドウから npm を選択します。

4. npm で Azure Artifacts を初めて使用する場合は、[ツールの取得] を選択し、手順に従って前提条件をインストールします。

5. Project セットアップの指示に従ってフィードに接続します。

   

その他

1. プロジェクトの ディレクトリに、package.json ファイルと同じディレクトリに .npmrc ファイルを追加し、次のスニペットをコピーします。

   registry=https://pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/ 
   
   always-auth=true
   

資格情報のセットアップ

1. 次のスニペットをユーザー レベル の npmrc ファイルにコピーします。

   • 組織スコープのフィード:

     ; begin auth token
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/registry/:email=npm requires email to be set but doesn't use the value
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:username=[ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/_packaging/<FEED_NAME>/npm/:email=npm requires email to be set but doesn't use the value
     ; end auth token
     

   • プロジェクト スコープ フィード:

     ; begin auth token
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/registry/:email=npm requires email to be set but doesn't use the value
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:username=[ENTER_ANY_VALUE_BUT_NOT_AN_EMPTY_STRING]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
     //pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_packaging/<FEED_NAME>/npm/:email=npm requires email to be set but doesn't use the value
     ; end auth token
     

2. 読み取りスコープと書き込みスコープをパッケージ化して個人用アクセス トークンを生成します。

3. 新しく生成された個人用アクセス トークンを次のようにエンコードします。

   1. コマンド プロンプト ウィンドウで次のコマンドを実行し、メッセージが表示されたら個人用アクセス トークンを貼り付けます。

      node -e "require('readline') .createInterface({input:process.stdin,output:process.stdout,historySize:0}) .question('PAT> ',p => { b64=Buffer.from(p.trim()).toString('base64');console.log(b64);process.exit(); })"
      

      次のコマンドを使用して、個人用アクセス トークンを Base 64 に変換することもできます。

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Base 64 でエンコードされた値をコピーします。

4. ユーザー .npmrc ファイル内の両方の [BA Standard Edition 64_ENCODED_PERSONAL_ACCESS_TOKEN] 値を、手順 3 の個人用アクセス トークンに置き換えます。

ヒント

.npmrc ファイルで複数のレジストリを使用することは、スコープとアップストリーム ソースでサポートされています。

パイプライン認証

パイプラインで認証するために、Azure Artifacts では npm 認証タスクを使用することをお勧めします。

gulp や Grunt などのタスク ランナーを使用する場合は、パイプラインの開始時に npm 認証タスクを含める必要があります。 このアクションにより、資格情報がプロジェクトの .npmrc ファイルに挿入され、パイプラインの実行全体で保持され、以降の手順で構成ファイル内の資格情報にアクセスできるようになります。

クラシック

1. プロジェクトに移動し、[パイプライン] を選択し、パイプライン定義を選択します。

2. [編集] を選び、パイプラインを編集します。

3. +選択すると、新しいタスクがパイプラインに追加されます。

   

4. npm 認証タスクを検索し、[追加] を選択します。

   

5. .npmrc ファイルを選択し、完了したら [保存してキュー] を選択します。

   

YAML

- task: npmAuthenticate@0
  inputs:
    workingFile: .npmrc                ## Path to the npmrc file
    customEndpoint: #Optional          ## Comma-separated list of npm service connection names for registries from external organizations. For registries in your org, leave this blank

Note

パイプラインがフィードにアクセスするには、フィード設定でビルド サービス ロールが Feed And Upstream Reader (Contributor) に設定されていることを確認します。

Note

組織でファイアウォールまたはプロキシ サーバーを使用している場合は、適切な doメイン URL を許可していることを確認します。 詳細については、「許可される IP アドレスと実行メイン URL」を参照してください。

トラブルシューティング

vsts-npm-auth が認識されない

プロジェクトの実行中に次のエラーが発生した場合:

• コマンド: 'vsts-npm-auth' is not recognized as an internal or external command, operable program or batch file.

• PowerShell: vsts-npm-auth : The term 'vsts-npm-auth' is not recognized as the name of a cmdlet, function, script file, or operable program.

その後、npm モジュール フォルダーがパスに追加されていない可能性があります。 これに対処するには、Node.jsセットアップを再実行し、必ずオプションを Add to PATH 選択してください。

または、コマンド プロンプトまたは $env:APPDATA\npm PowerShell で PATH 変数を変更して、npm モジュール フォルダーをパスに%APPDATA%\npm追加することもできます。

認証できない

E401 エラーが発生している場合: code E401 npm ERR! Unable to authenticate -F フラグをvsts-npm-auth指定してコマンドを実行して再認証します。

vsts-npm-auth -config .npmrc -F

vsts-npm-auth をリセットする

vsts-npm-auth 資格情報をリセットするには、次の手順に従います。

1. vsts-npm-auth をアンインストールします。

   npm uninstall -g vsts-npm-auth
   

2. npm キャッシュをクリアします。

   npm cache clean --force
   

3. .npmrc ファイルを削除します。

4. vsts-npm-auth を再インストールします。

   npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
   

関連記事

• npm パッケージの発行と復元 (CLI)
• npm パッケージを発行する (YAML/クラシック)
• npmjs.com のパッケージを使用する