docs icon indicating copy to clipboard operation
docs copied to clipboard

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

Open Falcion opened this issue 1 year ago • 3 comments
trafficstars

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:

  • [x] 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.
  • [x] For content changes, I have completed the self-review checklist.

Falcion avatar Jun 04 '24 04:06 Falcion

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.

welcome[bot] avatar Jun 04 '24 04:06 welcome[bot]

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

github-actions[bot] avatar Jun 04 '24 04:06 github-actions[bot]

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

nguyenalex836 avatar Jun 04 '24 15:06 nguyenalex836

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

github-actions[bot] avatar Jul 03 '24 21:07 github-actions[bot]

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.

Falcion avatar Jul 09 '24 15:07 Falcion

@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 avatar Jul 09 '24 16:07 nguyenalex836

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 :zap:

github-actions[bot] avatar Jul 09 '24 16:07 github-actions[bot]