將 npm 專案 連線 至 Azure Artifacts 摘要

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

Azure Artifacts 可讓開發人員從摘要和公用登錄發佈及安裝各種套件類型，例如 npmjs.com。 若要向 Azure Artifacts 進行驗證，您必須設定 npm 組態檔。 此檔案包含 npm 所使用的摘要 URL 和認證、提供自定義 npm 用戶端行為的選項，例如設定 Proxy、定義預設套件位置，或設定私人套件摘要。 .npmrc 檔案通常位於使用者的主目錄中，但也可以在專案層級建立以覆寫默認設定。 藉由修改 .npmrc 檔案，用戶可以個人化其 npm 體驗，以符合其特定需求。

必要條件

• Azure DevOps 組織和專案。 如果您尚未建立組織或專案。

• Azure Artifacts 摘要。 如果您還沒有摘要，請建立新的摘要 。

• 下載並安裝 Node.js 和 npm。

專案設定

如需最佳做法，建議您使用兩個不同的組態檔。 第一個用於向 Azure Artifacts 進行驗證，而第二個會儲存在本機並保存您的認證。

若要設定第二個檔案，只要將它放在開發電腦上的主目錄中，並包含所有登錄認證即可。 如此一來，npm 用戶端就可以輕鬆地存取您的認證以進行驗證，讓您共用組態檔，同時保護您的認證安全。

下列步驟將引導您設定第一個組態檔：

Windows

1. 登入您的 Azure DevOps 組織，然後瀏覽至您的專案。

2. 選取 [成品]，然後選取要摘要 連線。

   

3. 從左側瀏覽窗格中選取 npm 。

4. 如果這是第一次搭配 npm 使用 Azure Artifacts，請選取 [取得工具 ]，並依照指示安裝必要條件。

5. 請遵循 Project 安裝程式中的指示來連線到您的摘要。

   

其他

1. 在項目的目錄中，將 .npmrc 檔案新增至與package.json檔案相同的目錄中，並將下列代碼段複製到其中。

   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 檔案中的 [ BASE64_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

注意

若要讓管線存取您的摘要，請確定建置服務角色已設定為摘要設定中的摘要和上游讀取器（參與者）。

注意

如果您的組織使用防火牆或 Proxy 伺服器，請確定您允許適當的網域 URL。 如需詳細資訊，請參閱 允許的IP位址和網域URL 。

疑難排解

無法辨識 vsts-npm-auth

如果您在項目執行期間遇到下列錯誤：

• Cmd： '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 modules 資料夾可能尚未新增至您的路徑。 若要解決此問題，請重新執行Node.js設定，並確定選取 Add to PATH 選項。

或者，您也可以在命令提示字元或 $env:APPDATA\npm PowerShell 中將 PATH 變數修改為 %APPDATA%\npm ，將 npm modules 資料夾新增至路徑。

無法驗證

如果您遇到 E401 錯誤： code E401 npm ERR! Unable to authenticate。 vsts-npm-auth使用 -F 旗標執行命令以重新驗證。

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/Classic）
• 使用來自 npmjs.com 的套件