Редактиране

Споделяне чрез


Connect your npm project to Azure Artifacts

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

Azure Artifacts enables developers to manage their packages from various sources, including both public registries like npmjs.com and private feeds. To authenticate with Azure Artifacts, you'll need to configure your npm config file. This file contains feed URLs and credentials used by npm, offering options to customize your npm client behavior, such as setting up proxies, defining default package locations, or configuring private package feeds. The .npmrc file is typically located in the user's home directory but can also be created at the project level to override default settings.

Prerequisites

Connect to Feed

Azure Artifacts recommends using two separate configuration files. The first is dedicated to authenticating with Azure Artifacts, while the second should be kept locally to store your credentials. This approach allows you to share your configuration file while keeping your credentials secure.

To set up the second file, simply place it in your home directory on your development machine and include all your registry credentials. This enables the npm client to easily access your credentials for authentication.

The following steps will guide you through setting up the first configuration file:

Note

vsts-npm-auth is not supported in Azure DevOps Server.

  1. Sign in to your Azure DevOps organization, and then navigate to your project.

  2. Select Artifacts, and then select Connect to Feed.

    A screenshot showing how to connect to a feed in Azure DevOps Services.

  3. Select npm from the left sidebar. If this is the first time using Azure Artifacts with npm, make sure you've installed the prerequisites.

  4. Follow the instructions in the Project setup section to connect to your feed.

    A screenshot showing how to set up your npm project.

  1. Sign in to your Azure DevOps collection, and then navigate to your project.

  2. Select Artifacts, and then select Connect to Feed.

    A screenshot showing how to connect to a feed in Azure DevOps Server 2022.1.

  3. Select npm from the left sidebar, and then follow the instructions in the Project setup section to set up your config file.

    A screenshot showing how to set up your npm project in Azure DevOps Server 2022.1.

  1. Sign in to your Azure DevOps collection, and then navigate to your project.

  2. Select Artifacts, and then select Connect to feed.

    A screenshot showing how to connect to a feed in Azure DevOps Server 2020.1.

  3. Select npm from the left, and then follow the instructions in Project setup to set up your config file.

    A screenshot showing how to set up your npm project in Azure DevOps Server 2020.1.

  1. Sign in to your Azure DevOps collection, and then navigate to your project.

  2. Select Artifacts, and then select Connect to feed.

    A screenshot showing how to connect to a feed in Azure DevOps Server 2019.1.

  3. A new window will appear. From the left-hand navigation pane, select npm.

  4. Follow the provided instructions to configure your project and user .npmrc files.

    A screenshot showing how to set up your project-level and user-level npmrc files in Azure DevOps Server 2019.1.

Tip

Using multiple registries in .npmrc files is supported with scopes and upstream sources.

Pipeline authentication

To authenticate with your pipeline, Azure Artifacts recommends using the npm authenticate task.

When using task runners such as gulp or Grunt, it's to prioritize setting your npm authenticate task at the beginning of your pipeline. This step guarantees that your credentials are injected into your project's .npmrc file and retained throughout the pipeline run, enabling subsequent steps to access the credentials in the configuration file.

  1. Navigate to your project, select Pipelines, and then select your pipeline definition.

  2. Select Edit to modify your pipeline.

  3. Select + to add a new task to your pipeline.

    Screenshot showing how to add the npm authenticate task to your pipeline.

  1. Navigate to your project, select Pipelines > Builds, and then select your build definition.

  2. Select Edit to modify your build pipeline.

  3. Select + to add a new task to your build pipeline.

    Screenshot showing how to add the npm authenticate task to your pipeline.

  1. Search for the npm Authenticate task, and then select Add.

    Screenshot showing the npm authenticate task added to the pipeline.

  2. Select your .npmrc file, and then select Save & queue when you're done.

    Screenshot showing how to add your *.npmrc* file.

Note

To access your feed from your pipeline, make sure that the build service role is set to Feed And Upstream Reader (Contributor) in your Feed settings > Permissions.

A screenshot showing the build service roles in feed settings.

Note

If your organization is using a firewall or a proxy server, make sure you allow the appropriate domain URLs. See Allowed IP addresses and domain URLs for details.

Troubleshoot

vsts-npm-auth is not recognized

This error indicates that the npm modules folder hasn't been added to your path. Rerun the Node.js setup and make sure to select the Add to PATH option. Alternatively, you can add the npm modules folder to your path by modifying the PATH variable to %APPDATA%\npm in Command Prompt or $env:APPDATA\npm in PowerShell.

A Screenshot showing how to set up node.js.

Unable to authenticate

  • Error: code E401 npm ERR! Unable to authenticate: -> Run the vsts-npm-auth command with -F flag to reauthenticate:

    vsts-npm-auth -config .npmrc -F
    

Reset vsts-npm-auth

Follow these steps to reset your vsts-npm-auth credentials:

  1. Uninstall vsts-npm-auth:

    npm uninstall -g vsts-npm-auth
    
  2. Clear your npm cache:

    npm cache clean --force
    
  3. Delete your .npmrc file.

  4. Reinstall vsts-npm-auth:

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

Unable to publish

If you encounter a 403 error, it may indicate a name conflict. In Azure Artifacts, packages are immutable, meaning that once you publish a package to your feed, its version number is permanently reserved. Even if you delete it, you cannot publish a new package with the same version number. To address this issue, update the package version in your package.json file, and then try again.