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

Added an item with github source authentication to the dotnet CLI in the instructions for GitHub Packages #33314

Merged
merged 9 commits into from
Jul 9, 2024

Conversation

Falcion
Copy link
Contributor

@Falcion Falcion commented Jun 4, 2024

Why:

The article itself, although contains information on how to authenticate github source for NuGet integration with GitHub Packages still indicate GitHub Actions in the title, which can confuse a user who is working with GitHub Packages for the first time and is trying to upload their project manually (again using dotnet CLI)

Example of this experience is this discussion: https://github.com/orgs/community/discussions/49186

What's being changed (if available, include any code snippets, screenshots, or gifs):

Update guide in Publishing a package and Publishing a package using a nuget.config file and add step about authenticating GitHub Packages for user:

1. Authentificate GitHub Packages with the `dotnet` command-line interface (CLI). Replace `OWNER` with your username or company name.

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

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Jun 4, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 4, 2024
Copy link
Contributor

github-actions bot commented Jun 4, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team 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 and removed triage Do not begin working on this issue until triaged by the team labels Jun 4, 2024
@nguyenalex836
Copy link
Contributor

@Falcion Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added needs SME This proposal needs review from a subject matter expert labels Jul 3, 2024
Copy link
Contributor

github-actions bot commented Jul 3, 2024

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

Copy link
Contributor

@thyeggman thyeggman left a comment

Choose a reason for hiding this comment

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

This step already exists in the "Authenticating to GitHub Packages" section of the documentation, although it is formatted for use in a GitHub Actions workflow. I think the confusion is understandable, though.

I would suggest removing these two changes and moving the new part up to the above section. Use YOUR_GITHUB_PAT to match other examples instead of ${{ secrets.GITHUB_TOKEN }}. Mention that it is a command that can be run directly from the command line using the dotnet CLI instead of manually configuring a nuget.config file. Also check the spelling of "Authenticate" 👍

@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Jul 8, 2024
Falcion and others added 5 commits July 9, 2024 16:47
Co-authored-by: Jacob Wallraff <thyeggman@github.com>
1. Removed duplicates about auth;
2. Moved authentification with CLI into the "Publishing a package"
3. Replaced `${{ secrets.GITHUB_TOKEN }}` with `YOUR_GITHUB_PAT`
@Falcion
Copy link
Contributor Author

Falcion commented Jul 9, 2024

I apologize for the "spammy" commits with fixes and adjustments to your answer.

As was mentioned in the discussion, I removed the “duplicate” authorizations, changed ${{ secrets.GITHUB_TOKEN }} to YOUR_GITHUB_PAT, combined and moved the authorization instructions to the “Publish a package” block, if something else required, I'll be happy to try to fix/finish it.

@nguyenalex836
Copy link
Contributor

@Falcion Thank you so much for that last batch of adjustments! 💛 I'll update the branch and get this merged once tests are passing 🍏

@nguyenalex836 nguyenalex836 removed the more-information-needed More information is needed to complete review label Jul 9, 2024
@nguyenalex836 nguyenalex836 added this pull request to the merge queue Jul 9, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 9, 2024
@nguyenalex836 nguyenalex836 added this pull request to the merge queue Jul 9, 2024
Merged via the queue into github:main with commit a98837d Jul 9, 2024
44 checks passed
Copy link
Contributor

github-actions bot commented Jul 9, 2024

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team packages This issue or pull request should be reviewed by the docs packages team SME reviewed An SME has reviewed this issue/PR
3 participants