You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/artifacts/concepts/best-practices.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ This section outlines best practices for consuming packages with Azure Artifacts
63
63
64
64
-**Ensure the order of sources reflects your desired package resolution strategy**:
65
65
66
-
The feed checks upstream sources sequentially and will return the package from the first source that contains it. Be mindful of the order to ensure your feed resolves packages from the correct source. See [Order your upstream sources intentionally](upstream-sources.md#2-order-your-upstream-sources-intentionally) and [Search order](upstream-sources.md#search-order) for more details.
66
+
The feed checks upstream sources sequentially and will return the package from the first source that contains it. Be mindful of the order to ensure your feed resolves packages from the correct source. See [Order your upstream sources intentionally](upstream-sources.md#order-your-upstream-sources-intentionally) and [Search order](upstream-sources.md#search-order) for more details.
Azure Artifacts upstream sources enable developers to conveniently store packages from various sources in a single feed, including those you publish and those installed from external feeds or public registries like NuGet.org, npmjs.com. Once upstream sources are enabled, any package installed from an upstream source is automatically saved to your feed.
16
+
Azure Artifacts upstream sources allow developers to store packages from various origins in a single feed, including packages published to the feed and those installed from public registries like *NuGet.org* or *npmjs.com*. Once upstream sources are enabled, any package installed from an upstream source is automatically saved to your feed.
Enabling upstream sources provides several benefits for managing your product’s dependencies within a single feed:
22
+
Enabling upstream sources offers several advantages for managing your product’s dependencies within a single feed:
23
23
24
-
-**Simplicity**: Storing all your packages in a single feed simplifies your configuration files like NuGet.config, npmrc, or settings.xml. With just one feed in your config file, you reduce the chances of errors and streamline your setup.
24
+
-**Simplicity**: Storing all your packages in a single feed simplifies your configuration files like *NuGet.config*, *npmrc*, or *settings.xml*. With just one feed in your config file, you reduce setup complexity and minimize errors.
25
25
26
-
-**Consistent Builds**: Your feed resolves package requests in a defined order, ensuring more predictable and reliable builds.
26
+
-**Consistent Builds**: Your feed resolves package requests in a defined order, helping ensure predictable and reliable builds across environments.
27
27
28
28
-**Package Integrity**: Your feed retains metadata about packages saved from upstream sources, allowing you to verify their authenticity and ensure you're using the original versions, not copies or potentially malicious versions.
29
29
30
-
-**Reliability**: Packages installed from upstream sources are automatically saved to your feed. This ensures continued access even if the upstream source becomes unavailable due to maintenance or other issues so you can continue developing and building with confidence.
30
+
-**Reliability**: Packages installed from upstream sources are automatically saved to your feed. This ensures continued access even if the upstream source becomes temporarily unavailable due to maintenance or other issues so you can continue developing and building with confidence.
31
31
32
32
## Best practices for package consumers
33
33
34
34
To take full advantage of the benefits of upstream sources as a package consumer, follow these best practices:
35
35
36
-
#### 1. Use a single feed in your config file
36
+
#### Use a single feed in your configuration file
37
37
38
-
In order for your feed to provide a [deterministic restore](#search-order), make sure that your configuration file (such as nuget.config or npmrc) references only one feed with upstream sources enabled.
38
+
In order for your feed to provide a [deterministic restore](#search-order), make sure that your configuration file (such as *nuget.config* or *npmrc*) references **only one feed** with upstream sources enabled.
39
39
40
40
-**Examples**:
41
41
@@ -54,34 +54,37 @@ In order for your feed to provide a [deterministic restore](#search-order), make
54
54
> [!NOTE]
55
55
> NuGet compiles several [configuration files](/nuget/consume-packages/configuring-nuget-behavior) to determine the complete set of options to apply. Using `<clear />` ensures that all other package sources specified in higher-level configuration files are ignored.
56
56
57
-
#### 2. Order your upstream sources intentionally
57
+
#### Order your upstream sources intentionally
58
58
59
-
If you’re only using public registries like NuGet.org or npmjs.com, the order of your upstream sources doesn’t matter. Requests to the feed follow the sequence outlined in the [search order](#search-order) section.
59
+
If you're using only public registries like *NuGet.org* or *npmjs.com*, the order of upstream sources doesn’t affect behavior. Requests to the feed follow the sequence outlined in the [search order](#search-order) section.
60
60
61
-
However, when you're managing multiple sources, such as a combination of feeds and public registries, each upstream source is searched in the order defined in the feed’s configuration settings. In this case, we recommend placing the public registries first in the list of upstream sources.
61
+
However, when managing multiple sources, such as a combination of feeds and public registries, each upstream source is searched in the order defined in the feed’s configuration settings. In these cases, we recommend placing the public registries first in the list of upstream sources.
62
62
63
-
In some unique scenarios, some organizations modify open-source software (OSS) packages to address security concerns, enhance functionality, or meet specific internal requirements that require rebuilding the package internally rather than obtaining it directly from a public repository.
64
-
If your organization follows this practice, place the upstream source containing these customized OSS packages before other public registries. This ensures your customized versions are used instead of public ones.
63
+
In some unique scenarios, some organizations modify open-source software (OSS) packages to address security concerns, enhance functionality, or meet specific internal requirements that require rebuilding the package internally rather than obtaining it directly from a public repository.
64
+
If your organization follows this practice, place the upstream source containing these customized OSS packages before other public registries. This ensures your customized versions are used instead of the public ones.
65
65
66
66
## Best practices for feed owners and package publishers
67
67
68
68
To ensure your feed can be easily configured as an upstream source, follow these best practices:
69
69
70
-
#### 1. Use the default view
70
+
#### Use the default view
71
71
72
-
The default view for all newly created feeds is `@Local`, which contains all the packages published to your feed as well as packages saved from upstream sources.
72
+
All newly created feeds use the `@Local` view by default. This view includes:
73
+
74
+
- Packages published directly to the feed.
75
+
- Packages saved from upstream sources.
73
76
74
77
If you want to use other views such as a view for newly released package versions, you can promote your packages to the `@Release` view and then make that view available to your target consumers. See [Feed views](views.md) for more details.
75
78
76
-
#### 2. Construct a package graph
79
+
#### Construct a package graph
77
80
78
81
To construct a package graph, simply connect to the feed's default view and install the package you want to share. Once a package is saved to the default view, users who want to consume it will be able to resolve the package graph and install the desired version. Packages from upstream sources are displayed based on the configured view for the corresponding upstream source. See [How upstreams construct the set of available packages](package-graph.md#how-upstreams-construct-the-set-of-available-packages) for more details.
79
82
80
83
## Search order
81
84
82
85
For public package managers that support multiple feeds, such as NuGet and Maven, the order in which feeds are queried can sometimes be unclear or nondeterministic. For example, NuGet sends parallel queries to all the feeds in the configuration file and processes responses in a first-in, first-out (FIFO) manner, which can lead to inconsistent results.
83
86
84
-
Upstream sources eliminate this uncertainty by enforcing a structured search order, by searching the feed and its upstream sources in the following order:
87
+
Azure Artifacts upstream sources eliminate this uncertainty by enforcing a structured search order, by searching the feed and its upstream sources in the following order:
85
88
86
89
1. Packages that have been published directly to the feed.
87
90
@@ -90,15 +93,15 @@ Upstream sources eliminate this uncertainty by enforcing a structured search ord
90
93
1. Packages available from upstream sources. Each upstream source is searched in the order it's listed in the feed's configuration.
91
94
92
95
> [!NOTE]
93
-
> Azure Artifacts does not support searching for packages in upstream sources using the NuGet Package Explorer in Visual Studio.
96
+
> Azure Artifacts does not support searching for packages in upstream sources using the **NuGet Package Explorer** in Visual Studio.
94
97
95
98
## Save packages from upstream sources
96
99
97
-
When an upstream source is enabled on your feed, Azure Artifacts will automatically save a copy of any package installed by a collaborator or higher from upstream.
100
+
When an upstream source is enabled on your feed, Azure Artifacts automatically saves a copy of any package installed by a collaborator or higher from that upstream source.
98
101
99
-
For instance, you can install packages directly from the upstream source using a command like *npm install express*. Alternatively, packages might be installed as part of a dependency resolution process. In this case, installing *express* would also save its dependencies, such as *accepts*.
102
+
For example, you can install packages directly from the upstream source using a command like *npm install express*. Alternatively, packages might be installed as part of dependency resolution, so installing *express* would also save its dependencies, such as *accepts*.
100
103
101
-
Upstream sources provide an important safeguard for your consumers and infrastructure, protecting them from unexpected outages. If the upstream source experiences downtime, maintenance, or becomes temporarily unavailable, you can still retrieve the necessary packages from your feed and continue your development.
104
+
Upstream sources offer a critical safeguard for your consumers and infrastructure. If the public registry experiences downtime, maintenance, or becomes temporarily unavailable, you can still retrieve the necessary packages from your feed and continue your development.
102
105
103
106
::: moniker range="azure-devops"
104
107
@@ -109,70 +112,44 @@ Upstream sources provide an important safeguard for your consumers and infrastru
109
112
110
113
## Override packages from upstream sources
111
114
112
-
When you enable upstream sources, keep in mind that you cannot publish a package version that already exists in an upstream source. For example, if you enable the *NuGet.org* upstream, you won't be able to publish the *Newtonsoft.Json 10.0.3* package, as that version is already available on NuGet.org.
115
+
When upstream sources are enabled in your feed, you **cannot publish a package version that already exists** in one of those upstream sources. For example, if the *NuGet.org* upstream is enabled, you won’t be able to publish *Newtonsoft.Json 10.0.3* to your feed, since that version is already available on *NuGet.org*.
113
116
114
-
If you need to publish a package version that already exists in one of your upstream sources, you must follow these steps:
117
+
To override a package version from an upstream source:
115
118
116
119
1. Disable the relevant upstream source.
117
120
118
-
1. Publish your package.
121
+
1. Publish your desired package version to the feed.
119
122
120
123
1. Re-enable the upstream source.
121
124
122
-
This process ensures that you can publish the desired version while maintaining the integrity of your upstream sources.
125
+
This workflow ensures you can publish the desired version while maintaining the integrity of your upstream sources.
123
126
124
127
> [!NOTE]
125
128
> Package versions are immutable. Saved packages remain in the feed even if the upstream source is disabled or removed.
126
129
127
130
## Upstream sources health status
128
131
129
-
If a feed has a failing upstream source, the metadata for packages of the same protocol can no longer be refreshed. To check the health status of your upstream sources, follow these steps:
132
+
If a feed has a failing upstream source, metadata for packages using the same protocol can no longer be refreshed. To check the health status of your upstream sources, follow these steps:
130
133
131
-
1. Sign in to your Azure DevOps organization, and then navigate to your project.
134
+
1. Sign in to your Azure DevOps organization, and navigate to your project.
132
135
133
-
1. Select **Artifacts**, and then select your feed from the dropdown menu.
136
+
1. Select **Artifacts**, then select your feed from the dropdown menu.
134
137
135
-
1. Select the gear icon  to navigate to your **Feed settings**, and then select **Upstream sources**.
138
+
1. Select the gear icon  to open **Feed settings**, then select **Upstream sources**.
136
139
137
140
:::image type="content" source="media/last-sync-upstreams.png" alt-text="A screenshot showing the upstream sources last sync up status.":::
138
141
139
-
1. If any failures occur, a warning message will be displayed. Clicking on the *Failed* status provides additional details, including the cause of the failure and instructions on how to resolve it.
142
+
1. If any failures occur, a warning message will be displayed. Select the *Failed* status to view detailed information, including the cause of the failure and steps to resolve it.
140
143
141
144
:::image type="content" source="media/last-sync-upstreams-details.png" alt-text="A screenshot displaying details of the sync up failure.":::
142
145
143
146
> [!NOTE]
144
-
> For public registries like NuGet.org, there is a 3-6 hour delay between when a package is pushed to the public registry and when it becomes available for download. This delay depends on job timing and data propagation. However, when the upstream source is an Azure Artifacts feed, the latency is usually no more than a few minutes.
145
-
146
-
## FAQs
147
-
148
-
##### Q: I can't find my package even though I can see it in one of my feed's upstreams?
149
-
150
-
A: Packages from upstream sources become available in the downstream feed soon after they're published. However, the package will only be visible to readers after it has been saved to the feed. A package is saved when a user with [Feed and Upstream Reader (Collaborator)](../feeds/feed-permissions.md#feed-roles-and-permissions) or higher permissions installs the version in the downstream feed. This triggers the downstream to save a copy of the package from upstream, after which it is permanently saved and available in the downstream to all readers. This is when the package version becomes visible in the package versions section of the web UI.
151
-
152
-
##### Q: What are feed views?
153
-
154
-
A: Views allow developers to selectively share a subset of package versions that have been tested and validated, excluding any packages that are still under development or haven't met the quality criteria. See [What are feed views](./views.md) for more details.
155
-
156
-
##### Q: I can't find the feed that I want to configure as an upstream source?
157
-
158
-
A: Make sure that the feed's owner has shared a view as an upstream source. See [Add a feed in a different organization as an upstream source](../how-to/set-up-upstream-sources.md#add-a-feed-in-a-different-organization-as-an-upstream-source) for more details.
159
-
160
-
##### Q: Can a user with **Feed Reader** role download packages from an upstream source?
161
-
162
-
A: No. A user with the **Feed Reader** role in an Azure Artifacts feed can only download packages that have been saved to the feed. Packages are saved to the feed when a **Feed and Upstream Reader (Collaborator)**, **Feed Publisher (Contributor)**, or **Feed Owner** installs those packages from upstream.
163
-
164
-
##### Q: What happens when a user deletes or unpublishes a package saved from an upstream source?
165
-
166
-
A: The package becomes unavailable for download from the feed, and the version number is permanently reserved. Additionally, the package will no longer be saved from the upstream source. Earlier and later versions of the package will remain unaffected.
167
-
168
-
##### Q: What happens when a user deprecates a package saved from an upstream source?
169
-
170
-
A: When a user deprecates a package, a warning message is added to the package's metadata. This warning is displayed whenever the package is viewed or installed from the feed.
147
+
> For public registries like *NuGet.org*, there is typically a 3-6 hour delay between when a package is pushed to the public registry and when it becomes available for download. This delay depends on job timing and data propagation. However, when the upstream source is an Azure Artifacts feed, the latency is usually no more than a few minutes.
171
148
172
149
## Related content
173
150
174
151
- [Set up upstream sources](../how-to/set-up-upstream-sources.md)
175
152
176
153
- [Use upstream sources in a public feed](../how-to/public-feeds-upstream-sources.md)
0 commit comments