Conectar seu projeto npm ao Azure Artifacts

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

O Azure Artifacts permite que os desenvolvedores gerenciem seus pacotes de várias fontes, incluindo registros públicos, como npmjs.com e feeds privados. Para autenticar com o Azure Artifacts, você precisará configurar o arquivo de configuração npm. Esse arquivo contém URLs de feed e credenciais usadas pelo npm, oferecendo opções para personalizar o comportamento do cliente npm, como configurar proxies, definir locais de pacotes padrão ou configurar feeds de pacotes privados. O arquivo .npmrc normalmente está localizado no diretório inicial do usuário, mas também pode ser criado no nível do projeto para substituir as configurações padrão.

Pré-requisitos

Conectar-se ao feed

O Azure Artifacts recomenda o uso de dois arquivos de configuração separados. O primeiro é dedicado à autenticação com Azure Artifacts, enquanto o segundo deve ser mantido localmente para armazenar suas credenciais. Essa abordagem permite que você compartilhe seu arquivo de configuração enquanto mantém suas credenciais seguras.

Para configurar o segundo arquivo, basta colocá-lo em seu diretório base em seu computador de desenvolvimento e incluir todas as suas credenciais de registro. Isso permite que o cliente npm acesse facilmente suas credenciais para autenticação.

As etapas a seguir o guiarão pela configuração do primeiro arquivo de configuração:

Observação

vsts-npm-auth não há suporte em Azure DevOps Server.

  1. Entre na sua organização do Azure DevOps e navegue até seu projeto.

  2. Selecione Artefatos e, em seguida, selecione Conectar ao Feed.

    Uma captura de tela mostrando como se conectar a um feed em Azure DevOps Services.

  3. Selecione npm na barra lateral esquerda. Se esta for a primeira vez que você usa o Azure Artifacts com o npm, verifique se você instalou os pré-requisitos.

  4. Siga as instruções na seção Configuração do projeto para se conectar ao seu feed.

    Uma captura de tela mostrando como configurar seu projeto npm.

  1. Entre na sua coleção do Azure DevOps e navegue até seu projeto.

  2. Selecione Artefatos e, em seguida, selecione Conectar ao Feed.

    Uma captura de tela mostrando como se conectar a um feed em Azure DevOps Server 2022.1.

  3. Selecione npm na barra lateral esquerda e siga as instruções na seção Configuração do projeto para configurar seu arquivo de configuração.

    Uma captura de tela mostrando como configurar seu projeto npm em Azure DevOps Server 2022.1.

  1. Entre na sua coleção do Azure DevOps e navegue até seu projeto.

  2. Selecione Artefatos e, em seguida, selecione Conectar ao feed.

    Uma captura de tela mostrando como se conectar a um feed em Azure DevOps Server 2020.1.

  3. Selecione npm à esquerda e siga as instruções em Configuração do projeto para configurar o arquivo de configuração.

    Uma captura de tela mostrando como configurar seu projeto npm em Azure DevOps Server 2020.1.

  1. Entre na sua coleção do Azure DevOps e navegue até seu projeto.

  2. Selecione Artefatos e, em seguida, selecione Conectar ao feed.

    Uma captura de tela mostrando como se conectar a um feed em Azure DevOps Server 2019.1.

  3. Uma nova janela será exibida. No painel de navegação esquerdo, selecione npm.

  4. Siga as instruções fornecidas para configurar os arquivos .npmrc do projeto e do usuário .

    Uma captura de tela mostrando como configurar seus arquivos npmrc no nível do projeto e no nível do usuário em Azure DevOps Server 2019.1.

Dica

O uso de vários registros em arquivos .npmrc é suportado com escopos e fontes upstream.

Autenticação de pipeline

Para autenticar com seu pipeline, o Azure Artifacts recomenda usar a tarefa de autenticação npm.

Ao usar executores de tarefas como gulp ou Grunt, é para priorizar a configuração da tarefa de autenticação npm no início do pipeline. Essa etapa garante que suas credenciais sejam injetadas no arquivo .npmrc do projeto e mantidas durante toda a execução do pipeline, permitindo que as etapas subsequentes acessem as credenciais no arquivo de configuração.

  1. Navegue até o projeto, selecione Pipelines e, em seguida, selecione a definição do pipeline.

  2. Selecione Editar para modificar o pipeline.

  3. Selecione + para adicionar uma nova tarefa ao pipeline.

    Captura de tela mostrando como adicionar a tarefa de autenticação npm ao pipeline.

  1. Navegue até o projeto, selecione Builds de Pipelines e, em seguida, selecione sua definição de>build.

  2. Selecione Editar para modificar o pipeline de build.

  3. Selecione + para adicionar uma nova tarefa ao pipeline de build.

    Captura de tela mostrando como adicionar a tarefa de autenticação npm ao pipeline.

  1. Pesquise a tarefa Autenticar npm e selecione Adicionar.

    Captura de tela mostrando a tarefa de autenticação npm adicionada ao pipeline.

  2. Selecione o arquivo .npmrc e, em seguida, selecione Salvar e enfileirar quando terminar.

    Captura de tela mostrando como adicionar seu arquivo *.npmrc*.

Observação

Para acessar o feed do pipeline, verifique se a função de serviço de build está definida como Feed e Leitor Upstream (Colaborador) nas Permissões de configurações>do feed.

Uma captura de tela mostrando as funções de serviço de build nas configurações do feed.

Observação

Se sua organização estiver usando um firewall ou um servidor proxy, certifique-se de permitir as URLs de domínio apropriadas. Consulte Endereços IP permitidos e URLs de domínio para obter detalhes.

Solucionar problemas

vsts-npm-auth não é reconhecido

Esse erro indica que a pasta de módulos npm não foi adicionada ao seu caminho. Execute novamente a configuração do Node.js e certifique-se de selecionar a Add to PATH opção. Como alternativa, você pode adicionar a pasta npm modules ao seu caminho modificando a variável PATH para %APPDATA%\npm no Prompt de Comando ou $env:APPDATA\npm no PowerShell.

Uma captura de tela mostrando como configurar node.js.

Não é possível autenticar

  • Erro: código E401 npm ERR! Não é possível autenticar: -> Execute o comando com o vsts-npm-auth sinalizador -F para autenticar novamente:

    vsts-npm-auth -config .npmrc -F
    

Redefinir vsts-npm-auth

Siga estas etapas para redefinir suas credenciais vsts-npm-auth:

  1. Desinstale o vsts-npm-auth:

    npm uninstall -g vsts-npm-auth
    
  2. Limpe seu cache npm:

    npm cache clean --force
    
  3. Exclua seu arquivo .npmrc .

  4. Reinstale o vsts-npm-auth:

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

Não é possível publicar

Se você encontrar um erro 403, isso pode indicar um conflito de nome. No Azure Artifacts, os pacotes são imutáveis, o que significa que, depois que você publica um pacote em seu feed, seu número de versão é reservado permanentemente. Mesmo se você excluí-lo, não poderá publicar um novo pacote com o mesmo número de versão. Para resolver esse problema, atualize a versão do pacote no arquivo package.json e tente novamente.