Conectar el proyecto de npm a las fuentes de Azure Artifacts

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

Azure Artifacts permite a los desarrolladores publicar e instalar varios tipos de paquetes desde fuentes y registros públicos, como npmjs.com. Para autenticarse con Azure Artifacts, es necesario configurar el archivo de configuración de npm. Este archivo contiene direcciones URL de fuente y credenciales usadas por npm, ofreciendo opciones para personalizar el comportamiento del cliente de npm, como configurar servidores proxy, definir ubicaciones de paquetes predeterminadas o configurar fuentes de paquetes privadas. El archivo .npmrc se encuentra normalmente en el directorio principal del usuario, pero también se puede crear en el nivel de proyecto para invalidar la configuración predeterminada. Al modificar el archivo .npmrc, los usuarios pueden personalizar su experiencia de npm para satisfacer sus requisitos específicos.

Requisitos previos

• Una organización de Azure DevOps y un proyecto. Cree una organización o un proyecto si aún no lo ha hecho.

• Una fuente de Azure Artifacts. Cree una fuente si todavía no tiene una.

• Descargue e instale Node.js y npm.

Configuración del proyecto

Para conocer los procedimientos recomendados, se recomienda usar dos archivos de configuración independientes. La primera se usa para autenticarse con Azure Artifacts, mientras que la segunda se almacena localmente y contiene las credenciales.

Para configurar el segundo archivo, basta con colocarlo en el directorio principal en la máquina de desarrollo e incluir todas las credenciales del Registro. De este modo, el cliente npm puede acceder fácilmente a sus credenciales para la autenticación, lo que le permite compartir el archivo de configuración al tiempo que mantiene las credenciales seguras.

Los pasos siguientes le guiarán a través de la configuración del primer archivo de configuración:

Windows

1. Inicie sesión en su organización de Azure DevOps y vaya a su proyecto.

2. Seleccione Artefactos y, a continuación, seleccione Conectar para alimentar.

   

3. Seleccione npm en el panel de navegación izquierdo.

4. Si es la primera vez que usa Azure Artifacts con npm, seleccione Obtener las herramientas y siga las instrucciones para instalar los requisitos previos.

5. Siga las instrucciones de Configuración del proyecto para conectarse a la fuente.

   

Otros

1. Agregue un archivo .npmrc en el directorio del proyecto, en el mismo directorio que el archivo package.json y copie el fragmento de código siguiente en él.

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

Credenciales de instalación

1. Copie el siguiente fragmento de código en el archivo npmrc de nivel de usuario:

   • Fuente con ámbito de la organización:

     ; 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
     

   • Fuente con ámbito de proyecto:

     ; 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. Genere un token de acceso personal con ámbitos de lectura y escritura empaquetados.

3. Codifique el token de acceso personal recién generado de la siguiente manera:

   1. Ejecute el siguiente comando en una ventana del símbolo del sistema y pegue el token de acceso personal cuando se le solicite:

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

      También puede usar el siguiente comando para convertir el token de acceso personal a Base 64.

      • Linux/Mac:

        echo -n "YOUR_PERSONAL_ACCESS-TOKEN" | base64
        

   2. Copie el valor codificado en Base 64.

4. Reemplace ambos valores [BASE64_ENCODED_PERSONAL_ACCESS_TOKEN] en el archivo .npmrc de usuario por el token de acceso personal del paso 3.

Sugerencia

El uso de varios registros en archivos .npmrc se admite con ámbitos y orígenes ascendentes.

Autenticación de canalización

Para autenticarse con la canalización, Azure Artifacts recomienda usar la tarea de autenticación de npm.

Al usar ejecutores de tareas como gulp o Grunt, es importante incluir la tarea de autenticación de npm al principio de la canalización. Esta acción garantiza que las credenciales se insertan en el archivo .npmrc del proyecto y se conservan en toda la ejecución de la canalización, lo que permite que los pasos posteriores accedan a las credenciales en el archivo de configuración.

Clásico

1. Vaya al proyecto, seleccione Canalizaciones y, a continuación, seleccione la definición de canalización.

2. Seleccione Editar para modificar la canalización.

3. Seleccione + esta opción para agregar una nueva tarea a la canalización.

   

4. Busque la tarea Autenticación de npm y, a continuación, seleccione Agregar.

   

5. Seleccione el archivo .npmrc y, a continuación, seleccione Guardar y cola cuando haya terminado.

   

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

Nota:

Para que la canalización acceda a la fuente, asegúrese de que el rol de servicio de compilación esté establecido en Lector de fuente y ascendente (colaborador) en la configuración de la fuente.

Nota:

Si su organización usa un firewall o un servidor proxy, asegúrese de permitir las direcciones URL de dominio adecuadas. Consulte Direcciones IP permitidas y direcciones URL de dominio para obtener más información.

Solución de problemas

vsts-npm-auth no se reconoce

Si se produce el siguiente error durante la ejecución del proyecto:

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

A continuación, es probable que la carpeta de módulos npm no se haya agregado a la ruta de acceso. Para solucionarlo, vuelva a ejecutar la configuración de Node.js y asegúrese de seleccionar la Add to PATH opción .

Como alternativa, puede agregar la carpeta de módulos npm a la ruta de acceso modificando la variable PATH a %APPDATA%\npm en el símbolo del sistema o $env:APPDATA\npm en PowerShell.

No se puede autenticar

Si tiene un error E401: code E401 npm ERR! Unable to authenticate. Ejecute el vsts-npm-auth comando con la marca -F para volver a autenticarse.

vsts-npm-auth -config .npmrc -F

Restablecer vsts-npm-auth

Siga estos pasos para restablecer las credenciales de vsts-npm-auth:

1. Desinstalar vsts-npm-auth:

   npm uninstall -g vsts-npm-auth
   

2. Borre la caché de npm:

   npm cache clean --force
   

3. Elimine el archivo .npmrc .

4. Reinstale vsts-npm-auth:

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

Artículos relacionados

• Publicación y restauración de paquetes npm (CLI)
• Publicación de paquetes npm (YAML/clásico)
• Uso de paquetes de npmjs.com