Połączenie źródła danych npm projektu npm do źródeł danych usługi Azure Artifacts

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Usługa Azure Artifacts umożliwia deweloperom publikowanie i instalowanie różnych typów pakietów z kanałów informacyjnych i publicznych rejestrów, takich jak npmjs.com. Aby uwierzytelnić się za pomocą usługi Azure Artifacts, należy skonfigurować plik konfiguracji npm. Ten plik zawiera adresy URL kanału informacyjnego i poświadczenia używane przez narzędzie npm, oferując opcje dostosowywania zachowania klienta npm, takie jak konfigurowanie serwerów proxy, definiowanie domyślnych lokalizacji pakietów lub konfigurowanie prywatnych źródeł danych pakietów. Plik npmrc zazwyczaj znajduje się w katalogu głównym użytkownika, ale można go również utworzyć na poziomie projektu, aby zastąpić ustawienia domyślne. Modyfikując plik npmrc, użytkownicy mogą personalizować swoje środowisko npm, aby spełnić określone wymagania.

Wymagania wstępne

• Organizacja i projekt usługi Azure DevOps. Utwórz organizację lub projekt, jeśli jeszcze tego nie zrobiono.

• Źródło danych usługi Azure Artifacts. Utwórz nowe źródło danych , jeśli jeszcze go nie masz.

• Pobierz i zainstaluj Node.js i narzędzie npm.

Ustawienia projektu

W przypadku najlepszych rozwiązań zaleca się użycie dwóch oddzielnych plików konfiguracji. Pierwszy jest używany do uwierzytelniania za pomocą usługi Azure Artifacts, podczas gdy drugi jest przechowywany lokalnie i przechowuje poświadczenia.

Aby skonfigurować drugi plik, wystarczy umieścić go w katalogu głównym na maszynie dewelopera i dołączyć wszystkie poświadczenia rejestru. Dzięki temu klient npm może łatwo uzyskać dostęp do poświadczeń na potrzeby uwierzytelniania, umożliwiając udostępnianie pliku konfiguracji przy zachowaniu bezpieczeństwa poświadczeń.

Poniższe kroki przeprowadzą Cię przez proces konfigurowania pierwszego pliku konfiguracji:

Windows

1. Zaloguj się do organizacji usługi Azure DevOps, a następnie przejdź do projektu.

2. Wybierz pozycję Artefakty, a następnie wybierz pozycję Połączenie do kanału informacyjnego.

   

3. Wybierz pozycję npm w okienku nawigacji po lewej stronie.

4. Jeśli po raz pierwszy używasz usługi Azure Artifacts z narzędziem npm, wybierz pozycję Pobierz narzędzia i postępuj zgodnie z instrukcjami, aby zainstalować wymagania wstępne.

5. Postępuj zgodnie z instrukcjami w temacie Konfiguracja programu Project, aby nawiązać połączenie ze źródłem danych.

   

Inne

1. Dodaj plik npmrc w katalogu projektu w tym samym katalogu co plik package.json i skopiuj do niego poniższy fragment kodu.

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

Konfigurowanie poświadczeń

1. Skopiuj następujący fragment kodu do pliku npmrc na poziomie użytkownika:

   • Kanał informacyjny o zakresie organizacji:

     ; 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
     

   • Źródło danych o zakresie projektu:

     ; 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. Generowanie osobistego tokenu dostępu przy użyciu pakietów zakresów odczytu i zapisu.

3. Zakoduj nowo wygenerowany osobisty token dostępu w następujący sposób:

   1. Uruchom następujące polecenie w oknie wiersza polecenia, a następnie wklej osobisty token dostępu po wyświetleniu monitu:

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

      Możesz również użyć następującego polecenia, aby przekonwertować osobisty token dostępu na bazę 64.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Skopiuj wartość zakodowaną w formacie Base 64.

4. Zastąp obie wartości [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] w pliku npmrc użytkownika osobistym tokenem dostępu z kroku 3.

Napiwek

Używanie wielu rejestrów w plikach npmrc jest obsługiwane z zakresami i źródłami nadrzędnymi.

Uwierzytelnianie potoku

Aby uwierzytelnić się w potoku, usługa Azure Artifacts zaleca użycie zadania uwierzytelniania npm.

W przypadku korzystania z modułów uruchamiaczy zadań, takich jak gulp lub Grunt, ważne jest, aby uwzględnić zadanie uwierzytelniania npm na początku potoku. Ta akcja gwarantuje, że poświadczenia są wstrzykiwane do pliku npmrc projektu i przechowywane w całym przebiegu potoku, umożliwiając kolejne kroki uzyskiwania dostępu do poświadczeń w pliku konfiguracji.

Klasyczny

1. Przejdź do projektu, wybierz pozycję Potoki, a następnie wybierz definicję potoku.

2. Wybierz pozycję Edytuj , aby zmodyfikować potok.

3. Wybierz + , aby dodać nowe zadanie do potoku.

   

4. Wyszukaj zadanie npm Uwierzytelnij, a następnie wybierz pozycję Dodaj.

   

5. Wybierz plik npmrc, a następnie wybierz pozycję Zapisz i kolejkę po zakończeniu.

   

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

Uwaga

Aby potok uzyskiwał dostęp do kanału informacyjnego, upewnij się, że rola usługi kompilacji jest ustawiona na Źródło danych i czytelnik nadrzędny (współautor) w ustawieniach kanału informacyjnego.

Uwaga

Jeśli twoja organizacja korzysta z zapory lub serwera proxy, upewnij się, że zezwalasz na odpowiednie adresy URL domeny. Aby uzyskać szczegółowe informacje, zobacz Dozwolone adresy IP i adresy URL domeny.

Rozwiązywanie problemów

Vsts-npm-auth nie jest rozpoznawany

Jeśli podczas wykonywania projektu wystąpi następujący błąd:

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

Jest prawdopodobne, że folder npm modules nie został dodany do ścieżki. Aby rozwiązać ten problem, uruchom ponownie Node.js instalatora i upewnij się, że wybrano Add to PATH opcję .

Alternatywnie możesz dodać folder npm modules do ścieżki, modyfikując zmienną PATH w %APPDATA%\npm wierszu polecenia lub $env:APPDATA\npm w programie PowerShell.

Nie można wykonać uwierzytelnienia

Jeśli wystąpi błąd E401: code E401 npm ERR! Unable to authenticate. vsts-npm-auth Uruchom polecenie z flagą -F, aby ponownie uwierzytelnić.

vsts-npm-auth -config .npmrc -F

Resetowanie vsts-npm-auth

Wykonaj następujące kroki, aby zresetować poświadczenia vsts-npm-auth:

1. Odinstaluj vsts-npm-auth:

   npm uninstall -g vsts-npm-auth
   

2. Wyczyść pamięć podręczną npm:

   npm cache clean --force
   

3. Usuń plik npmrc.

4. Zainstaluj ponownie vsts-npm-auth:

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

Powiązane artykuły

• Publikowanie i przywracanie pakietów npm (interfejs wiersza polecenia)
• Publikowanie pakietów npm (YAML/Classic)
• Używanie pakietów z npmjs.com