docs icon indicating copy to clipboard operation
docs copied to clipboard

Possible incorrect sample code to add NuGet source for GitHub Packages

Open carlos-quintero opened this issue 1 year ago • 1 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

Working with the NuGet registry (https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry)

What part(s) of the article would you like to see updated?

The section Authenticating in a GitHub Actions workflow uses this code to add a Nuget feed source for GitHub Packages with the nuget registry:

dotnet nuget add source --username USERNAME --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/NAMESPACE/index.json"

and the instruction about the NAMESPACE placeholder is:

Replace NAMESPACE with the name of the personal account or organization to which your packages are scoped.

But nothing is said about the USERNAME placeholder. Which value should be used? (it cannot be omitted because the username parameter is mandatory in the command dotnet nuget add source if the password parameter is supplied).

Additional information

No response

carlos-quintero avatar Jun 30 '24 15:06 carlos-quintero

@carlos-quintero Thank you for opening an issue! I'll get this triaged for review ✨

nguyenalex836 avatar Jul 01 '24 18:07 nguyenalex836

@carlos-quintero - Thank you for raising this. We could clarify what USERNAME should be - e.g. by using the same wording as in the Microsoft documentation for this: https://learn.microsoft.com/lb-lu/dotnet/core/tools/dotnet-nuget-add-source#options

I've marked this issue help-wanted. If you (or anyone else reading this) would like to raise a pull request to update the docs accordingly that would be great.

Information about contributing to the docs: https://docs.github.com/en/contributing

hubwriter avatar Jul 02 '24 10:07 hubwriter