az npm-projekt Csatlakozás az Azure Artifacts-hírcsatornákba

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

Az Azure Artifacts lehetővé teszi a fejlesztők számára, hogy különböző csomagtípusokat tegyenek közzé és telepítsenek hírcsatornákból és nyilvános nyilvántartásokból, például npmjs.com. Az Azure Artifacts használatával történő hitelesítéshez konfigurálnia kell az npm konfigurációs fájlját. Ez a fájl tartalmazza az npm által használt hírcsatorna URL-címeit és hitelesítő adatait, és olyan beállításokat kínál, amelyekkel testre szabhatja az npm-ügyfél viselkedését, például proxykat állíthat be, alapértelmezett csomaghelyeket definiálhat, vagy privát csomagcsatornákat konfigurálhat. Az .npmrc fájl általában a felhasználó kezdőlapján található, de a projekt szintjén is létrehozható az alapértelmezett beállítások felülbírálásához. Az .npmrc fájl módosításával a felhasználók személyre szabhatják az npm-élményt, hogy megfeleljenek az adott követelményeknek.

Előfeltételek

• Egy Azure DevOps-szervezet és egy projekt. Ha még nem tette meg, hozzon létre egy szervezetet vagy projektet.

• Azure Artifacts-hírcsatorna. Hozzon létre egy új hírcsatornát, ha még nem rendelkezik ilyen hírcsatornával .

• Töltse le és telepítse a Node.js és az npm fájlt.

Projekt beállítása

Az ajánlott eljárásokhoz ajánlott két különálló konfigurációs fájlt használni. Az első az Azure Artifacts hitelesítésére szolgál, míg a második helyileg van tárolva, és a hitelesítő adatokat tárolja.

A második fájl beállításához egyszerűen helyezze a kezdőkönyvtárba a fejlesztőgépen, és adja meg az összes beállításjegyzékbeli hitelesítő adatait. Így az npm-ügyfél egyszerűen hozzáférhet a hitelesítő adataihoz hitelesítés céljából, így megoszthatja a konfigurációs fájlt, miközben a hitelesítő adatok biztonságban maradnak.

Az alábbi lépések végigvezetik az első konfigurációs fájl beállításán:

Windows

1. Jelentkezzen be az Azure DevOps-szervezetbe, és lépjen a projekthez.

2. Válassza az Összetevők lehetőséget, majd válassza a Csatlakozás a hírcsatornához.

   

3. Válassza az npm lehetőséget a bal oldali navigációs panelen.

4. Ha most először használja az Azure Artifactst npm-lel, válassza az Eszközök lekérése lehetőséget, és kövesse az utasításokat az előfeltételek telepítéséhez.

5. A hírcsatornához való csatlakozáshoz kövesse a Project beállításának utasításait.

   

Egyéb

1. Vegyen fel egy .npmrc-fájlt a projekt könyvtárába, ugyanabban a könyvtárban, mint a package.json fájl, és másolja bele a következő kódrészletet.

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

Hitelesítő adatok beállítása

1. Másolja a következő kódrészletet a felhasználói szintű npmrc-fájlba :

   • Szervezeti hatókörű hírcsatorna:

     ; 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
     

   • Projekt hatókörű hírcsatorna:

     ; 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. Személyes hozzáférési jogkivonat létrehozása olvasási és írási hatókörök csomagolásával.

3. Az újonnan létrehozott személyes hozzáférési jogkivonat kódolása az alábbiak szerint történik:

   1. Futtassa a következő parancsot egy parancssori ablakban, majd illessze be a személyes hozzáférési jogkivonatot, amikor a rendszer kéri:

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

      A személyes hozzáférési jogkivonatot a következő paranccsal is konvertálhatja Base 64-esre.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Másolja ki a Base 64 kódolású értéket.

4. Cserélje le mindkét [BA Standard kiadás 64_ENCODED_PERSONAL_ACCESS_TOKEN] értéket a felhasználói .npmrc fájlban a 3. lépésben szereplő személyes hozzáférési jogkivonatra.

Tipp.

Az .npmrc-fájlokban több adatbázis használata is támogatott hatókörökkel és felsőbb rétegbeli forrásokkal.

Folyamathitelesítés

A folyamattal való hitelesítéshez az Azure Artifacts az npm hitelesítési feladat használatát javasolja.

Ha olyan feladatfuttatókat használ, mint a gulp vagy a Grunt, fontos, hogy az npm-hitelesítést a folyamat elején adja meg. Ez a művelet biztosítja, hogy a hitelesítő adatok be legyenek ágyazva a projekt .npmrc fájljába, és a folyamatfuttatás során megmaradjanak, így a konfigurációs fájlban lévő hitelesítő adatokhoz való hozzáférés további lépései is lehetővé teszik.

Klasszikus

1. Lépjen a projekthez, válassza a Folyamatok lehetőséget, majd válassza ki a folyamatdefiníciót.

2. A folyamat módosításához válassza a Szerkesztés lehetőséget.

3. Válassza ki + , ha új feladatot szeretne hozzáadni a folyamathoz.

   

4. Keresse meg az npm-hitelesítési feladatot, majd válassza a Hozzáadás lehetőséget.

   

5. Válassza ki az .npmrc fájlt, majd amikor végzett, válassza a Mentés > üzenetsor lehetőséget.

   

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

Feljegyzés

Ahhoz, hogy a folyamat hozzáférhessen a hírcsatornához, győződjön meg arról, hogy a buildszolgáltatás szerepköre a hírcsatorna beállításai között a Feed And Upstream Reader (Közreműködő) értékre van állítva.

Feljegyzés

Ha a szervezet tűzfalat vagy proxykiszolgálót használ, győződjön meg arról, hogy engedélyezi a megfelelő tartományi URL-címeket. Részletekért lásd: Engedélyezett IP-címek és tartomány URL-címek .

Hibaelhárítás

a vsts-npm-auth nem ismerhető fel

Ha a projekt végrehajtása során a következő hibát tapasztalja:

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

Akkor valószínű, hogy az npm-modulok mappája nem lett hozzáadva az elérési úthoz. A probléma megoldásához futtassa újra a Node.js beállítást, és mindenképpen válassza ki a Add to PATH lehetőséget.

Másik lehetőségként hozzáadhatja az npm-modulok mappát az elérési úthoz úgy, hogy %APPDATA%\npm a PATH változót a parancssorban vagy $env:APPDATA\npm a PowerShellben módosítja.

Nem lehet hitelesíteni

Ha E401-hiba lép fel: code E401 npm ERR! Unable to authenticate. Futtassa a parancsot -vsts-npm-authF jelölővel az újrahitelesítéshez.

vsts-npm-auth -config .npmrc -F

A vsts-npm-auth alaphelyzetbe állítása

A vsts-npm-auth hitelesítő adatainak alaphelyzetbe állításához kövesse az alábbi lépéseket:

1. Távolítsa el a vsts-npm-auth parancsot:

   npm uninstall -g vsts-npm-auth
   

2. Törölje az npm-gyorsítótárat:

   npm cache clean --force
   

3. Törölje az .npmrc fájlt.

4. A vsts-npm-auth újratelepítése:

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

Kapcsolódó cikkek

• NPM-csomagok közzététele és visszaállítása (CLI)
• NPM-csomagok közzététele (YAML/Klasszikus)
• Csomagok használata npmjs.com