Verbinding maken uw NPM-project naar Azure Artifacts-feeds

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

Met Azure Artifacts kunnen ontwikkelaars verschillende pakkettypen publiceren en installeren vanuit feeds en openbare registers, zoals npmjs.com. Als u wilt verifiëren met Azure Artifacts, moet u uw npm-configuratiebestand configureren. Dit bestand bevat feed-URL's en referenties die worden gebruikt door npm, met opties voor het aanpassen van uw npm-clientgedrag, zoals het instellen van proxy's, het definiëren van standaardpakketlocaties of het configureren van privépakketfeeds. Het NPMRC-bestand bevindt zich meestal in de basismap van de gebruiker, maar kan ook worden gemaakt op projectniveau om standaardinstellingen te overschrijven. Door het .npmrc-bestand te wijzigen, kunnen gebruikers hun npm-ervaring aanpassen aan hun specifieke vereisten.

Vereisten

• Een Azure DevOps-organisatie en een project. Maak een organisatie of een project als u dat nog niet hebt gedaan.

• Een Azure Artifacts-feed. Maak een nieuwe feed als u er nog geen hebt.

• Download en installeer Node.js en npm.

Projectinstellingen

Voor aanbevolen procedures is het raadzaam om twee afzonderlijke configuratiebestanden te gebruiken. De eerste wordt gebruikt voor verificatie met Azure Artifacts, terwijl de tweede lokaal wordt opgeslagen en uw referenties bevat.

Als u het tweede bestand wilt instellen, plaatst u het in uw basismap op uw ontwikkelcomputer en neemt u al uw registerreferenties op. Op deze manier heeft de npm-client eenvoudig toegang tot uw referenties voor verificatie, zodat u uw configuratiebestand kunt delen terwijl uw referenties veilig blijven.

De volgende stappen helpen u bij het instellen van het eerste configuratiebestand:

Windows

1. Meld u aan bij uw Azure DevOps-organisatie en navigeer vervolgens naar uw project.

2. Selecteer Artefacten en selecteer vervolgens Verbinding maken die u wilt invoeren.

   

3. Selecteer npm in het linkernavigatiedeelvenster.

4. Als dit de eerste keer is dat u Azure Artifacts met npm gebruikt, selecteert u De hulpprogramma's ophalen en volgt u de instructies om de vereisten te installeren.

5. Volg de instructies in De installatie van Project om verbinding te maken met uw feed.

   

Overig

1. Voeg een NPMRC-bestand toe aan de map van uw project, in dezelfde map als het package.json-bestand en kopieer het volgende fragment erin.

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

Referenties instellen

1. Kopieer het volgende fragment naar uw npmrc-bestand op gebruikersniveau:

   • Feed met organisatiebereik:

     ; 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
     

   • Feed met projectbereik:

     ; 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. Genereer een persoonlijk toegangstoken met lees- en schrijfbereiken voor pakketten.

3. Codeer uw zojuist gegenereerde persoonlijke toegangstoken als volgt:

   1. Voer de volgende opdracht uit in een opdrachtpromptvenster en plak uw persoonlijke toegangstoken wanneer u hierom wordt gevraagd:

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

      U kunt ook de volgende opdracht gebruiken om uw persoonlijke toegangstoken te converteren naar Base 64.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Kopieer de met Base 64 gecodeerde waarde.

4. Vervang beide [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] waarden in het NPMRC-bestand van uw gebruiker door uw persoonlijke toegangstoken uit stap 3.

Tip

Het gebruik van meerdere registers in NPMRC-bestanden wordt ondersteund met bereiken en upstream-bronnen.

Pijplijnverificatie

Om te verifiëren met uw pijplijn, raadt Azure Artifacts aan om de npm-verificatietaak te gebruiken.

Wanneer u taaklopers zoals gulp of Grunt gebruikt, is het belangrijk dat u uw npm-verificatietaak aan het begin van uw pijplijn opneemt. Deze actie zorgt ervoor dat uw referenties worden opgenomen in het NPMRC-bestand van uw project en worden bewaard tijdens de pijplijnuitvoering, zodat de volgende stappen toegang hebben tot de referenties in het configuratiebestand.

Klassiek

1. Navigeer naar uw project, selecteer Pijplijnen en selecteer vervolgens uw pijplijndefinitie.

2. Selecteer Bewerken om uw pijplijn te wijzigen.

3. Selecteer + deze optie om een nieuwe taak toe te voegen aan uw pijplijn.

   

4. Zoek de npm-verificatietaak en selecteer vervolgens Toevoegen.

   

5. Selecteer uw NPMRC-bestand en selecteer vervolgens Opslaan en wachtrij wanneer u klaar bent.

   

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

Notitie

Zorg ervoor dat de rol van de buildservice is ingesteld op Feed and Upstream Reader (Inzender) in uw feedinstellingen voor uw pijplijn om toegang te krijgen tot uw feed.

Notitie

Als uw organisatie een firewall of een proxyserver gebruikt, moet u ervoor zorgen dat u de juiste domein-URL's toestaat. Zie Toegestane IP-adressen en domein-URL's voor meer informatie.

Problemen oplossen

vsts-npm-auth wordt niet herkend

Als er de volgende fout optreedt tijdens de uitvoering van het project:

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

Dan is het waarschijnlijk dat de map npm-modules niet is toegevoegd aan uw pad. Voer hiervoor de Node.js setup opnieuw uit en zorg ervoor dat u de Add to PATH optie selecteert.

U kunt ook de map npm-modules toevoegen aan uw pad door de variabele PATH te %APPDATA%\npm wijzigen in de opdrachtprompt of $env:APPDATA\npm in PowerShell.

Kan niet verifiëren

Als er een E401-fout optreedt: code E401 npm ERR! Unable to authenticate. Voer de vsts-npm-auth opdracht uit met de vlag -F om opnieuw te verifiëren.

vsts-npm-auth -config .npmrc -F

Vsts-npm-auth opnieuw instellen

Volg deze stappen om uw referenties voor vsts-npm-auth opnieuw in te stellen:

1. Vsts-npm-auth verwijderen:

   npm uninstall -g vsts-npm-auth
   

2. Wis uw NPM-cache:

   npm cache clean --force
   

3. Verwijder het NPMRC-bestand .

4. Installeer vsts-npm-auth opnieuw:

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

Verwante artikelen:

• Npm-pakketten publiceren en herstellen (CLI)
• NPM-pakketten publiceren (YAML/Klassiek)
• Pakketten uit npmjs.com gebruiken