Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #109

Merged
merged 4 commits into from
Jul 12, 2019
Merged

Update readme #109

merged 4 commits into from
Jul 12, 2019

Conversation

satbai
Copy link
Contributor

@satbai satbai commented Jul 12, 2019

Making the readme better
#110
#89

@satbai satbai changed the title Users/satbai/update readme Update readme Jul 12, 2019
@satbai satbai force-pushed the users/satbai/updateReadme branch from e555cad to 49adcb5 Compare July 12, 2019 20:09
@satbai satbai requested review from elbatk and zarenner July 12, 2019 21:11
README.md Outdated

### Automatic PowerShell installation:
Using the above is recommended, but as per [NuGet's plugin discovery rules](https://github.com/NuGet/Home/wiki/NuGet-Cross-Plat-Credential-Plugin#plugin-installation-and-discovery), alternatively you can install the credential provider to a location you prefer, and then set the environment variable NUGET_PLUGIN_PATHS to the .exe of the credential provider found in plugins\netfx\CredentialProvider.Microsoft\CredentialProvider.Microsoft.exe. For example, $env:NUGET_PLUGIN_PATHS="my-alternative-location\CredentialProvider.Microsoft.exe".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will break dotnet (at least until NuGet/Home#8151 is fixed). Please update this guidance to make that clear.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll remove it from under dotnet and leave it for under nuget

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, nuget has the issue as well? Maybe I'll just add a link to the bug here. I'll think about this one.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Linux and Mac" instructions below are perfectly fine, since dotnet is the only possibility there.

You don't need to remove it from here IMO, it should just indicate that setting the envvar to the .exe credprovider will break dotnet on windows, and setting the envvar to the .dll will break nuget.exe and MSBuild on windows.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Therefore customers that use both dotnet and nuget.exe/MSBuild (.NET Framework) should probably avoid that envvar for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added "Note that if you are using both nuget and dotnet, this environment variable is not recommended due to this issue: NuGet/Home#8151"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for the windows section, but is unnecessary for the linux/mac section (running nuget.exe and the .exe credprovider is not supported)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I guess I'm ready for the weekend.

@satbai satbai force-pushed the users/satbai/updateReadme branch from 51c8204 to d0829b7 Compare July 12, 2019 21:30
README.md Outdated
@@ -88,6 +96,12 @@ msbuild /t:restore /p:nugetInteractive=true

Once you've successfully acquired a token, you can run authenticated commands without the `/p:nugetInteractive=true` switch.

### unattended build agents
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: capitalize

@satbai satbai force-pushed the users/satbai/updateReadme branch from d0829b7 to 3fc3036 Compare July 12, 2019 21:39
@satbai satbai merged commit ab24990 into master Jul 12, 2019
@satbai satbai deleted the users/satbai/updateReadme branch January 12, 2021 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants