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

Possible incorrect sample code to add NuGet source for GitHub Packages #33778

Closed
1 task done
carlos-quintero opened this issue Jun 30, 2024 · 2 comments · Fixed by #33798
Closed
1 task done

Possible incorrect sample code to add NuGet source for GitHub Packages #33778

carlos-quintero opened this issue Jun 30, 2024 · 2 comments · Fixed by #33798
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue packages This issue or pull request should be reviewed by the docs packages team

Comments

@carlos-quintero
Copy link

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 carlos-quintero added the content This issue or pull request belongs to the Docs Content team label Jun 30, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 30, 2024
@nguyenalex836
Copy link
Contributor

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

@nguyenalex836 nguyenalex836 added packages This issue or pull request should be reviewed by the docs packages team waiting for review Issue/PR is waiting for a writer's review actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels Jul 1, 2024
@hubwriter hubwriter added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 2, 2024
@hubwriter
Copy link
Contributor

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue packages This issue or pull request should be reviewed by the docs packages team
3 participants