Tutorial: How to use upstream sources

Artiklu
06/07/2022
4 minuti biex taqra

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Using upstream sources in your feed enables you to manage your application dependencies from a single feed. Using upstream sources makes it easy to consume packages from public registries while having protection against outages or compromised packages. You can also publish your own packages to the same feed and manage all your dependencies in one location.

This tutorial will walk you through how to enable upstream sources on your feed and consume packages from public registries such as NuGet.org or npmjs.com.

In this tutorial, you will:

Create a new feed and enable upstream sources.
Set up your configuration file.
Run an initial package restore to populate your feed.
Check your feed to view the saved copy of the packages you consumed from the public registry.

Create a feed and enable upstream sources

Select Artifacts.

Select Build & Release, and then select Packages.

Select Create Feed to create a new feed.

Select New Feed to create a new feed.

Provide a name for your feed, and then select its visibility. Make sure your check the Include packages from common public sources checkbox to enable upstream sources. Select Create when you are done

Provide a name for your feed, and then select its visibility. Make sure your check the Include packages from common public sources checkbox to enable upstream sources. Select Create when you are done

Set up the configuration file

Now that we created our feed, we need to update the config file to point to our feed. To do this we must:

Get the source's URL
Update the configuration file

Select Artifacts, and then select Connect to feed.
On the left side of the page, select the npm tab.
Follow the instructions in the Project setup section to set up your config file.

Select Build & Release > Packages, and then select Connect to Feed.
Copy the highlighted snippet to add it to your config file.

If you don't have a .npmrc file already, create a new one in the root of your project (in the same folder as your package.json). Open your new .npmrc file and paste the snippet you just copied in the previous step.

Select Artifacts, and then select your feed from the dropdown list.
Select Connect to feed, and then select pip under the Python section.
Create a virtual environment if you haven't done so already.
Add a pip.ini (Windows) or pip.conf (Mac/Linux) file to your virtualenv and paste the following snippet:
```
[global]
index-url=https://pkgs.dev.azure.com/ORGANIZATION-NAME/_packaging/FEED-NAME/pypi/simple/
```

Select Artifacts, and then select your feed from the dropdown list.
Select Connect to feed, and then select twine under the Python section.

Add a .pypirc file to your home directory and paste the following snippet:

[distutils]
Index-servers = FEED-NAME

[FEED-NAME]
Repository = https://pkgs.dev.azure.com/ORGANIZATION-NAME/_packaging/FEED-NAME/pypi/upload/

Tip

If you already have a .pypirc file, remove the [pypi] section if your file contains credentials.

Select Artifacts, and then select your feed from the dropdown list.
Select Connect to feed, and then select Maven.

Add the following snippet to the <repositories> and <distributionManagement> sections in your pom.xml:

<repository>
  <id>[FEED-NAME]</id>
  <url>https://pkgs.dev.azure.com/[ORGANIZATION-NAME]/_packaging/[FEED-NAME]/maven/v1</url>
  <releases>
    <enabled>true</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

Add a <server> to your settings.xml file:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                              https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
      <id>[FEED-NAME]</id>
      <username>[ORGANIZATION-NAME]</username>
      <password>[PERSONAL_ACCESS_TOKEN]</password>
    </server>
  </servers>
</settings>

Create a personal access token with Packaging > Read & write scopes and paste your personal access token into the <password> tag in your settings.xml file.

Select Artifacts, and then select your feed from the dropdown list.
Select Connect to feed, and then select Gradle.

Add the following snippet to the repositories and publishing sections in your build.gradle file:

maven {
    url 'https://pkgs.dev.azure.com/[ORGANIZATION-NAME]/_packaging/[FEED-NAME]/maven/v1'
    name '[FEED-NAME]'
    authentication {
        basic(BasicAuthentication)
    }
}

Add a <server> to your settings.xml file:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                              https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
      <id>[FEED-NAME]</id>
      <username>[ORGANIZATION-NAME]</username>
      <password>[PERSONAL_ACCESS_TOKEN]</password>
    </server>
  </servers>
</settings>

Create a personal access token with Packaging > Read & write scopes. Paste your personal access token into the <password> tag in your settings.xml file.

Restore packages

Now that you enabled upstream sources and set up your configuration file, we can run the package restore command to query the upstream source and retrieve the upstream packages.

We recommend clearing your local cache first before running the nuget restore. Azure Artifacts will have a saved copy of any packages you installed from upstream.

npm
NuGet

Remove the node_modules folder from your project and run the following command in an elevated command prompt window:

npm install --force

Note

The --force argument will force pull remotes even if a local copy exists.

Your feed now should contain any packages you saved from the upstream source.

Tutorial: How to use upstream sources

Create a feed and enable upstream sources

Set up the configuration file

Restore packages

Related articles

Feedback