Uw NPM-project verbinden met Azure Artifacts

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

Met Azure Artifacts kunnen ontwikkelaars hun pakketten beheren vanuit verschillende bronnen, waaronder zowel openbare registers zoals npmjs.com als privéfeeds. 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.

Vereisten

• een Azure DevOps-organisatie. Maak gratis een account.

• Een Azure DevOps-project. Maak een nieuw project als u er nog geen hebt.

• Een Azure Artifacts-feed. Maak gratis een account.

• Download en installeer Node.js en npm.

Verbinding maken met feed

Azure Artifacts raadt aan twee afzonderlijke configuratiebestanden te gebruiken. De eerste is bedoeld voor verificatie met Azure Artifacts, terwijl de tweede lokaal moet worden bewaard om uw referenties op te slaan. Met deze methode kunt u uw configuratiebestand delen terwijl uw referenties veilig blijven.

Als u het tweede bestand wilt instellen, plaatst u het in uw basismap op uw ontwikkelcomputer en neemt u al uw registerreferenties op. Hierdoor heeft de NPM-client eenvoudig toegang tot uw referenties voor verificatie.

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 met feed.

   

3. Selecteer npm in de linkerzijbalk. Als dit de eerste keer is dat u Azure Artifacts met npm gebruikt, controleert u of u de vereisten hebt geïnstalleerd.

4. Volg de instructies in de sectie Project-installatie om verbinding te maken met uw feed.

   

Overig

1. Voeg een NPMRC-bestand toe aan de map van uw project, in dezelfde map als uw package.json bestand en plak 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 en plak het in 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. Voer de volgende opdracht uit in een opdrachtpromptvenster en plak uw persoonlijke toegangstoken wanneer u hierom wordt gevraagd. Als u klaar bent, kopieert u de gegenereerde base 64-gecodeerde waarde.

   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. Als u linux/Mac gebruikt, kunt u ook de volgende opdracht gebruiken om uw persoonlijke toegangstoken te converteren naar Base 64. Kopieer de resulterende met Base64 gecodeerde waarde.

   echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
   

5. Vervang de tijdelijke aanduidingen [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] in het .npmrc-bestand van uw gebruiker door het gecodeerde persoonlijke toegangstoken dat is verkregen uit de vorige stap.

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, moet u prioriteit geven aan het instellen van uw npm-verificatietaak aan het begin van uw pijplijn. Deze stap garandeert 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

Als u toegang wilt krijgen tot uw feed vanuit uw pijplijn, moet u ervoor zorgen dat de rol van de buildservice is ingesteld op Feed and Upstream Reader (Inzender) in de machtigingen voor feedinstellingen>.

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

Deze fout geeft aan dat de map npm-modules niet is toegevoegd aan uw pad. Voer de installatie van de Node.js 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

• Fout: code E401 npm ERR! Kan niet verifiëren: -> 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
   

Publiceren lukt niet

Als er een 403-fout optreedt, kan dit duiden op een naamconflict. In Azure Artifacts zijn pakketten onveranderbaar, wat betekent dat wanneer u een pakket naar uw feed publiceert, het versienummer permanent wordt gereserveerd. Zelfs als u het verwijdert, kunt u geen nieuw pakket met hetzelfde versienummer publiceren. Als u dit probleem wilt oplossen, werkt u de pakketversie in uw package.json-bestand bij en probeert u het opnieuw.

Verwante artikelen:

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