Подключение проекта npm к артефактам Azure

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

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

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

• Организация Azure DevOps. Создайте ее бесплатно.

• Проект Azure DevOps. Создайте проект , если у вас еще нет этого проекта .

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

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

Подключиться к веб-каналу

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

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

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

Windows

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

2. Выберите артефакты и нажмите кнопку "Подключиться к каналу".

   

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

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

   

Другое

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
     

   • Веб-канал с областью действия проекта:

     ; 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. Выполните следующую команду в окне командной строки и вставьте личный маркер доступа при появлении запроса. После этого скопируйте созданное значение в кодировке 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. Если вы используете Linux или Mac, можно также использовать следующую команду для преобразования личного маркера доступа в Base 64. Скопируйте полученное значение в кодировке Base64.

   echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
   

5. Замените заполнители [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] в файле NPMRC пользователя на закодированный личный маркер доступа, полученный на предыдущем шаге.

Совет

Использование нескольких реестров в 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 не распознается

Эта ошибка означает, что папка модулей npm не добавлена в путь. Повторно запустите программу установки Node.js и выберите Add to PATH этот параметр. Кроме того, можно добавить папку модулей npm в путь, изменив переменную PATH в %APPDATA%\npm командной строке или $env:APPDATA\npm в PowerShell.

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

• Ошибка: код E401 npm ERR! Не удается выполнить проверку подлинности: выполните команду с флагом 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
   

Не удалось опубликовать изменения

Если возникла ошибка 403, это может указывать на конфликт имен. В Azure Artifacts пакеты неизменяемы, что означает, что после публикации пакета в веб-канале его номер версии постоянно зарезервирован. Даже если удалить его, вы не можете опубликовать новый пакет с тем же номером версии. Чтобы устранить эту проблему, обновите версию пакета в файле package.json и повторите попытку.

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

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