Подключение проект npm в веб-каналы Артефактов Azure

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

Артефакты Azure позволяют разработчикам публиковать и устанавливать различные типы пакетов из веб-каналов и общедоступных реестров, таких как npmjs.com. Чтобы выполнить проверку подлинности с помощью артефактов Azure, необходимо настроить файл конфигурации npm. Этот файл содержит URL-адреса и учетные данные веб-канала, используемые npm, предлагая параметры настройки поведения клиента npm, такие как настройка прокси-серверов, определение расположений пакетов по умолчанию или настройка частных веб-каналов пакетов. NPMRC-файл обычно находится в домашнем каталоге пользователя, но также может быть создан на уровне проекта для переопределения параметров по умолчанию. Изменив NPMRC-файл, пользователи могут персонализировать свой интерфейс npm в соответствии с конкретными требованиями.

Необходимые компоненты

• Организация Azure DevOps и проект. Создайте организацию или проект, если вы еще не сделали этого.

• Веб-канал артефактов Azure. Создайте веб-канал , если у вас еще нет.

• Скачайте и установите Node.js и npm.

Настройка проекта

Для получения рекомендаций рекомендуется использовать два отдельных файла конфигурации. Первый используется для проверки подлинности с помощью артефактов Azure, а второй — локально и содержит учетные данные.

Чтобы настроить второй файл, просто поместите его в домашний каталог на компьютере разработки и включите все учетные данные реестра. Таким образом, клиент npm может легко получить доступ к учетным данным для проверки подлинности, что позволяет предоставить общий доступ к файлу конфигурации при сохранении безопасности учетных данных.

Ниже приведены инструкции по настройке первого файла конфигурации:

Windows

1. Войдите в организацию Azure DevOps и перейдите к проекту.

2. Выберите артефакты и выберите Подключение для канала.

   

3. Выберите npm в области навигации слева.

4. Если это первый раз с помощью Azure Artifacts с npm, выберите " Получить средства " и следуйте инструкциям по установке необходимых компонентов.

5. Следуйте инструкциям в разделе "Настройка проекта", чтобы подключиться к веб-каналу.

   

Другое

1. Добавьте npmrc-файл в каталог проекта в том же каталоге, что и файл package.json, и скопируйте в него следующий фрагмент кода.

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

Настройка учетных данных

1. Скопируйте следующий фрагмент кода в файл npmrc уровня пользователя:

   • Веб-канал область организации:

     ; 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
     

   • Веб-канал project-область d:

     ; 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. Создайте личный маркер доступа с упаковкой область чтения и записи.

3. Закодируйте созданный личный маркер доступа следующим образом:

   1. Выполните следующую команду в окне командной строки и вставьте личный маркер доступа при появлении запроса:

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

      Вы также можете использовать следующую команду для преобразования личного маркера доступа в Base 64.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Скопируйте закодированное значение Base 64.

4. Замените оба значения [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] в файле npmrc пользователя личным маркером доступа на шаге 3.

Совет

Использование нескольких реестров в NPMRC-файлах поддерживается с область и источниками вышестоящий.

Проверка подлинности конвейера

Для проверки подлинности с помощью конвейера Azure Artifacts рекомендуется использовать задачу проверки подлинности npm.

При использовании средств выполнения задач, таких как gulp или Grunt, важно включить задачу проверки подлинности npm в начале конвейера. Это действие гарантирует, что учетные данные вставляются в NPMRC-файл проекта и сохраняются во время выполнения конвейера, что позволяет последующим шагам получить доступ к учетным данным в файле конфигурации.

Классическое

1. Перейдите к проекту, выберите "Конвейеры" и выберите определение конвейера.

2. Нажмите кнопку "Изменить", чтобы изменить конвейер.

3. Выберите + , чтобы добавить новую задачу в конвейер.

   

4. Найдите задачу проверки подлинности npm и нажмите кнопку "Добавить".

   

5. Выберите NPMRC-файл, а затем нажмите кнопку "Сохранить и очередь" после завершения.

   

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

Примечание.

Для доступа к веб-каналу убедитесь, что роль службы сборки имеет значение Feed And Upstream Reader (Участник) в параметрах веб-канала.

Примечание.

Если ваша организация использует брандмауэр или прокси-сервер, убедитесь, что вы разрешаете соответствующие URL-адреса домена. Дополнительные сведения см. в разделе "Разрешенные IP-адреса" и URL-адреса домена.

Устранение неполадок

vsts-npm-auth не распознается

При возникновении следующей ошибки во время выполнения проекта:

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

Возможно, папка модулей npm не добавлена в путь. Чтобы устранить эту проблему, выполните повторную настройку Node.js и выберите Add to PATH этот параметр.

Кроме того, можно добавить папку модулей npm в путь, изменив переменную PATH в %APPDATA%\npm командной строке или $env:APPDATA\npm в PowerShell.

Не удается пройти проверку подлинности

Если вы работаете с ошибкой E401: code E401 npm ERR! Unable to authenticate Выполните команду с флагом vsts-npm-auth -F для повторной проверки подлинности.

vsts-npm-auth -config .npmrc -F

Сброс vsts-npm-auth

Выполните следующие действия, чтобы сбросить учетные данные vsts-npm-auth:

1. Удалите vsts-npm-auth:

   npm uninstall -g vsts-npm-auth
   

2. Снимите кэш npm:

   npm cache clean --force
   

3. Удалите NPMRC-файл.

4. Переустановите vsts-npm-auth:

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

Связанные статьи

• Публикация и восстановление пакетов npm (CLI)
• Публикация пакетов npm (YAML/Classic)
• Использование пакетов из npmjs.com