Skip to content

Commit

Permalink
Merged PR 497124: Update docs to show new "Set up the new Azure Artif…
Browse files Browse the repository at this point in the history
…acts Credential Provider"

The artifacts "Connect to Feed" dialog now shows a new option to install the Azure Artifacts Credential Provider, and no longer advertises the older credentialProviderBundle.zip.  This PR updates the screenshot to show the modified UI.

The new credential provider also requires nuget 4.8+, so the minimum recommended nuget version is also updated (was 3.5+).
  • Loading branch information
Peter Spillman committed Aug 21, 2019
1 parent 1f29adb commit 6b8ff29
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 34 deletions.
Binary file modified docs/artifacts/_shared/_img/nugeturl-azure-devops-newnav.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 0 additions & 6 deletions docs/artifacts/_shared/nuget/nuget-3x.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/artifacts/_shared/nuget/nuget-publish-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ms.topic: include
::: moniker-end

::: moniker range=">=tfs-2017 < azure-devops"
::: moniker range=">=tfs-2017 < azure-devops-2019"

1. Go to your feed ([or create a feed if you haven't](../../feeds/create-feed.md)).

Expand Down
6 changes: 6 additions & 0 deletions docs/artifacts/_shared/nuget/nuget-recommended-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
ms.topic: include
---

> [!NOTE]
> The Azure Artifacts service recommends NuGet 4.8.2 or later. However, Azure Artifacts also supports legacy NuGet 2.x clients. For a complete list of the latest clients, see the [NuGet distribution page](http://dist.nuget.org/index.html).
2 changes: 1 addition & 1 deletion docs/artifacts/_shared/nuget/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ First, get the tools and your feed URL:
> [!NOTE]
>
> * The NuGet client's push command requires an API key. You can use any non-empty string you want. In this example, we used `key`.
> * If you're prompted for credentials on the command line, ensure that the downloaded credential provider is in the same folder as NuGet.exe. For more help in using credential providers with NuGet, see [Authenticating feeds with nuget.exe credential providers](https://docs.microsoft.com/nuget/reference/extensibility/nuget-exe-credential-providers). For Azure DevOps, use a personal access token when prompted for credentials, see [Authenticate access with personal access tokens](https://docs.microsoft.com/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts).
> * If you're prompted for credentials on the command line, ensure that you set up the [Azure Artifacts Credential Provider](https://go.microsoft.com/fwlink/?linkid=2099625). For more help in using credential providers with NuGet, see [NuGet Cross Platform Plugins](https://docs.microsoft.com/nuget/reference/extensibility/nuget-cross-platform-plugins). For Azure DevOps, use a personal access token when prompted for credentials, see [Authenticate access with personal access tokens](https://docs.microsoft.com/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts).
## Get or create a sample package to push

Expand Down
4 changes: 2 additions & 2 deletions docs/artifacts/nuget/move-from-fileshares.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ However, if you have workflows that publish packages with newer binaries without
This prevents invalid packages from entering your development and build environments.
However, any workflow that publishes malformed packages will break when moving to Azure DevOps Services NuGet feeds.

### NuGet 3.x is recommended
### NuGet 4.8+ is recommended

[!INCLUDE [nuget-3x](../_shared/nuget/nuget-3x.md)]
[!INCLUDE [nuget-recommended-version](../_shared/nuget/nuget-recommended-version.md)]

### Authentication and authorization

Expand Down
27 changes: 3 additions & 24 deletions docs/artifacts/nuget/nuget-exe.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ monikerRange: '>= tfs-2018'
> [!NOTE]
> This page covers interactive scenarios. In Azure Pipelines, use the NuGet step to [restore](/azure/devops/pipelines/packages/nuget-restore) and [publish](/azure/devops/pipelines/artifacts/nuget) packages.
[!INCLUDE [nuget-3x](../_shared/nuget/nuget-3x.md)]
[!INCLUDE [nuget-recommended-version](../_shared/nuget/nuget-recommended-version.md)]

## Add a feed to NuGet 3 or later
NuGet 3 and later supports the Credential Provider, which automatically acquires feed credentials when needed.
## Add a feed to NuGet 4.8.2 or later
NuGet 4.8.2 and later supports the Azure Artifacts Credential Provider, which automatically acquires feed credentials when needed.

1. Navigate to your feed ([or create a feed if you haven't](../feeds/create-feed.md)).

Expand Down Expand Up @@ -111,24 +111,3 @@ nuget.exe sources add -name {your feed name} -source {your feed URL} -username {

Then, run any [nuget command](/nuget/tools/nuget-exe-cli-reference).

## Download the credential provider directly
You can download the credential provider directly from this link. Replace `{org_name}` with your organization name:
`https://pkgs.dev.azure.com/{org_name}/_apis/public/nuget/client/CredentialProviderBundle.zip`

## Advanced credential provider scenarios
### Install the credential provider
By default, the credential provider works alongside NuGet.exe.

For advanced scenarios, you can choose where to install the provider:

- **Projects with a developer command prompt or enlistment:** Use the provider from an
[environment variable](http://docs.nuget.org/Consume/Credential-Providers#using-a-credential-provider-from-an-environment-variable) by copying `CredentialProvider.Vss.exe` to any folder, then run this command in PowerShell: `$env:NUGET_CREDENTIALPROVIDERS_PATH = {your folder}`
- **Projects using a non-Azure DevOps Services CI server:** Use the provider from an
[environment variable](http://docs.nuget.org/Consume/Credential-Providers#using-a-credential-provider-from-an-environment-variable)
- **Work on an individual machine:** Install the provider
[globally](http://docs.nuget.org/Consume/Credential-Providers#installing-a-credential-provider-globally) by copying `CredentialProvider.Vss.exe` to `$env:LOCALAPPDATA\NuGet\CredentialProviders`

### Bootstrap into your workflow

You can also add the provider to your enlistment or developer command prompt using our [bootstrap tools](bootstrap-nuget.md).
This is recommended if you're using the provider in a multi-engineer development environment.

0 comments on commit 6b8ff29

Please sign in to comment.