將 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 檔案通常位於使用者的主目錄中，但也可以在專案層級建立以覆寫默認設定。

必要條件

• Azure DevOps 組織。 免費建立一個。

• Azure DevOps 專案。 如果您還沒有專案，請建立新的 專案 。

• Azure Artifacts 摘要。 免費建立一個。

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

線上至摘要

Azure Artifacts 建議使用兩個不同的組態檔。 第一個是專門用來向 Azure Artifacts 進行驗證，而第二個應該保留在本機以儲存您的認證。 這種方法可讓您共用組態檔，同時保護您的認證。

若要設定第二個檔案，只要將它放在開發電腦上的主目錄中，並包含您的所有登錄認證即可。 這可讓 npm 用戶端輕鬆地存取您的認證以進行驗證。

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

Windows

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

2. 選取 [ 成品]，然後選取 [ 聯機至摘要]。

   

3. 從左側提要欄位中選取 npm 。 如果這是第一次搭配 npm 使用 Azure Artifacts，請確定您已安裝必要條件。

4. 請遵循 [項目設定] 區段中的指示，聯機到您的摘要。

   

其他

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. 在命令提示字元視窗中執行下列命令，然後在出現提示時貼上您的個人存取令牌。 完成後，複製產生的Base 64編碼值。

   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(); })"
   

4. 如果您是在 Linux/Mac 上，您也可以使用下列命令，將個人存取令牌轉換成 Base 64。 複製產生的Base64編碼值。

   echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
   

5. 將使用者 .npmrc 檔案中的佔位元 [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] 取代為從上一個步驟取得的編碼個人存取令牌。

提示

在 .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

此錯誤表示 npm modules 資料夾尚未新增至您的路徑。 重新執行Node.js設定，並確定選取 Add to PATH 選項。 或者，您也可以在命令提示字元或 $env:APPDATA\npm PowerShell 中將 PATH 變數修改為 %APPDATA%\npm ，將 npm modules 資料夾新增至路徑。

無法驗證

• 錯誤：代碼 E401 npm ERR！無法驗證： -> 使用 -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
   

無法發佈

如果您遇到 403 錯誤，則可能表示名稱衝突。 在 Azure Artifacts 中，套件是不可變的，這表示一旦您將套件發佈至摘要，就會永久保留其版本號碼。 即使您刪除它，也無法發佈具有相同版本號碼的新套件。 若要解決此問題，請更新package.json檔案中的套件版本，然後再試一次。

相關文章

• 發佈和還原 npm 套件 （CLI）
• 發佈 npm 套件 （YAML/Classic）
• 使用來自 npmjs.com 的套件