Anslut npm-projektet till Azure Artifacts-feeds

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Med Azure Artifacts kan utvecklare publicera och installera olika pakettyper från feeds och offentliga register som npmjs.com. Om du vill autentisera med Azure Artifacts är det nödvändigt att konfigurera npm-konfigurationsfilen. Den här filen innehåller feed-URL:er och autentiseringsuppgifter som används av npm och erbjuder alternativ för att anpassa npm-klientbeteendet, till exempel konfigurera proxyservrar, definiera standardpaketplatser eller konfigurera privata paketfeeds. .npmrc-filen finns vanligtvis i användarens hemkatalog men kan också skapas på projektnivå för att åsidosätta standardinställningarna. Genom att ändra .npmrc-filen kan användarna anpassa sin npm-upplevelse för att uppfylla sina specifika krav.

Förutsättningar

• En Azure DevOps-organisation och ett projekt. Skapa en organisation eller ett projekt om du inte redan har gjort det.

• En Azure Artifacts-feed. Skapa en ny feed om du inte redan har en.

• Ladda ned och installera Node.js och npm.

Projektinställningar

För bästa praxis rekommenderar vi att du använder två separata konfigurationsfiler. Den första används för autentisering med Azure Artifacts, medan den andra lagras lokalt och innehåller dina autentiseringsuppgifter.

Om du vill konfigurera den andra filen placerar du den i din hemkatalog på utvecklingsdatorn och inkluderar alla dina registerautentiseringsuppgifter. På så sätt kan npm-klienten enkelt komma åt dina autentiseringsuppgifter för autentisering, så att du kan dela konfigurationsfilen samtidigt som du håller dina autentiseringsuppgifter säkra.

Följande steg vägleder dig genom att konfigurera den första konfigurationsfilen:

Windows

1. Logga in på din Azure DevOps-organisation och navigera sedan till projektet.

2. Välj Artefakter och välj sedan Anslut som ska matas.

   

3. Välj npm i det vänstra navigeringsfönstret.

4. Om det är första gången du använder Azure Artifacts med npm väljer du Hämta verktygen och följer anvisningarna för att installera förutsättningarna.

5. Följ anvisningarna i Project-konfigurationen för att ansluta till feeden.

   

Övrigt

1. Lägg till en .npmrc-fil i projektets katalog, i samma katalog som din package.json-fil, och kopiera följande kodfragment till den.

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

Konfigurera autentiseringsuppgifter

1. Kopiera följande kodfragment till npmrc-filen på användarnivå:

   • Flöde med organisationsomfattning:

     ; 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
     

   • Flöde med projektomfattning:

     ; 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. Generera en personlig åtkomsttoken med paketering av läs- och skrivomfattningar .

3. Koda din nyligen genererade personliga åtkomsttoken på följande sätt:

   1. Kör följande kommando i kommandotolken och klistra sedan in din personliga åtkomsttoken när du uppmanas att göra det:

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

      Du kan också använda följande kommando för att konvertera din personliga åtkomsttoken till Base 64.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Kopiera det base 64-kodade värdet.

4. Ersätt båda [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]- värdena i användarens .npmrc-fil med din personliga åtkomsttoken från steg 3.

Dricks

Användning av flera register i .npmrc-filer stöds med omfång och överordnade källor.

Pipelineautentisering

För att autentisera med din pipeline rekommenderar Azure Artifacts att du använder npm-autentisera uppgiften.

När du använder aktivitetslöpare som gulp eller Grunt är det viktigt att ta med npm-autentisera uppgiften i början av pipelinen. Den här åtgärden säkerställer att dina autentiseringsuppgifter matas in i projektets .npmrc-fil och behålls under pipelinekörningen, vilket gör det möjligt för efterföljande steg att komma åt autentiseringsuppgifterna i konfigurationsfilen.

Klassisk

1. Gå till projektet, välj Pipelines och välj sedan din pipelinedefinition.

2. Välj Redigera för att ändra pipelinen.

3. Välj + för att lägga till en ny uppgift i pipelinen.

   

4. Sök efter npm Authenticate-uppgiften och välj sedan Lägg till.

   

5. Välj .npmrc-filen och välj sedan Spara & kö när du är klar.

   

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

Kommentar

För att din pipeline ska få åtkomst till feeden kontrollerar du att byggtjänstrollen är inställd på Feed And Upstream Reader (Deltagare) i feedinställningarna.

Kommentar

Om din organisation använder en brandvägg eller en proxyserver kontrollerar du att du tillåter lämpliga domän-URL:er. Mer information finns i Tillåtna IP-adresser och domän-URL:er .

Felsöka

vsts-npm-auth känns inte igen

Om du stöter på följande fel under projektkörningen:

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

Då är det troligt att mappen npm-moduler inte har lagts till i sökvägen. Du kan åtgärda detta genom att köra Node.js installationsprogrammet igen och se till att välja alternativet Add to PATH .

Du kan också lägga till mappen npm-moduler i sökvägen genom att ändra PATH-variabeln till %APPDATA%\npm i Kommandotolken eller $env:APPDATA\npm i PowerShell.

Det gick inte att autentisera

Om du stöter på ett E401-fel: code E401 npm ERR! Unable to authenticate. vsts-npm-auth Kör kommandot med flaggan -F för att autentisera igen.

vsts-npm-auth -config .npmrc -F

Återställ vsts-npm-auth

Följ dessa steg för att återställa dina vsts-npm-auth-autentiseringsuppgifter:

1. Avinstallera vsts-npm-auth:

   npm uninstall -g vsts-npm-auth
   

2. Rensa npm-cachen:

   npm cache clean --force
   

3. Ta bort .npmrc-filen.

4. Installera om vsts-npm-auth:

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

Relaterade artiklar

• Publicera och återställa npm-paket (CLI)
• Publicera npm-paket (YAML/klassisk)
• Använda paket från npmjs.com