Łączenie projektu npm z usługą Azure Artifacts

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

Usługa Azure Artifacts umożliwia deweloperom zarządzanie pakietami z różnych źródeł, w tym zarówno publicznych rejestrów, jak npmjs.com, jak i prywatnych źródeł. Aby przeprowadzić uwierzytelnianie za pomocą usługi Azure Artifacts, musisz 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.

Wymagania wstępne

• Organizacja: Azure DevOps. Utwórz je bezpłatnie.

• Projekt usługi Azure DevOps. Utwórz nowy projekt , jeśli jeszcze go nie masz.

• Źródło danych usługi Azure Artifacts. Utwórz je bezpłatnie.

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

Nawiązywanie połączenia z kanałem informacyjnym

Usługa Azure Artifacts zaleca używanie dwóch oddzielnych plików konfiguracji. Pierwsza jest przeznaczona do uwierzytelniania za pomocą usługi Azure Artifacts, a druga powinna być przechowywana lokalnie w celu przechowywania poświadczeń. Takie podejście umożliwia udostępnianie pliku konfiguracji przy zachowaniu bezpieczeństwa poświadczeń.

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 uzyskiwać dostęp do poświadczeń na potrzeby uwierzytelniania.

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łącz z kanałem informacyjnym.

   

3. Wybierz pozycję npm na lewym pasku bocznym. Jeśli po raz pierwszy używasz usługi Azure Artifacts z narzędziem npm, upewnij się, że zainstalowano wymagania wstępne.

4. Postępuj zgodnie z instrukcjami w sekcji Konfiguracja projektu, 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 wklej 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 i wklej go 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. Uruchom następujące polecenie w oknie wiersza polecenia, a następnie wklej osobisty token dostępu po wyświetleniu monitu. Po zakończeniu skopiuj wygenerowaną wartość zakodowaną w formacie Base 64.

   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. Jeśli korzystasz z systemu Linux/Mac, możesz też użyć następującego polecenia, aby przekonwertować osobisty token dostępu na bazę 64. Skopiuj wynikową wartość zakodowaną w formacie Base64.

   echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
   

5. Zastąp symbole zastępcze [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] w pliku npmrc użytkownika zakodowanym osobistym tokenem dostępu uzyskanym z poprzedniego kroku.

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 używania modułów uruchamiaczy zadań, takich jak gulp lub Grunt, należy określić priorytety ustawiania zadania uwierzytelniania npm na początku potoku. Ten krok 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 uzyskać dostęp do kanału informacyjnego z potoku, 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 Uprawnienia.

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

Ten błąd wskazuje, że folder npm modules nie został dodany do ścieżki. 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

• Błąd: kod E401 npm ERR! Nie można uwierzytelnić: —> uruchom vsts-npm-auth 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
   

Nie można opublikować

Jeśli wystąpi błąd 403, może to oznaczać konflikt nazw. W usłudze Azure Artifacts pakiety są niezmienne, co oznacza, że po opublikowaniu pakietu w kanale informacyjnym jego numer wersji jest trwale zarezerwowany. Nawet jeśli go usuniesz, nie można opublikować nowego pakietu z tym samym numerem wersji. Aby rozwiązać ten problem, zaktualizuj wersję pakietu w pliku package.json , a następnie spróbuj ponownie.

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