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

Package authentication documentation has confusing PAT wording #33925

Closed
1 task done
syntastical opened this issue Jul 10, 2024 · 8 comments
Closed
1 task done

Package authentication documentation has confusing PAT wording #33925

syntastical opened this issue Jul 10, 2024 · 8 comments
Labels
content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review packages This issue or pull request should be reviewed by the docs packages team SME reviewed An SME has reviewed this issue/PR stale There is no recent activity on this issue or pull request

Comments

@syntastical
Copy link

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry
https://docs.github.com/en/packages/learn-github-packages/publishing-a-package

What changes are you suggesting?

Remove the reusable section that states
GitHub Packages only supports authentication using a personal access token (classic). For more information, see "[Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).". But this isn't true, and is directly contradicted by references to using GITHUB_SECRET in GitHub actions.

Additional information

No response

@syntastical syntastical added the content This issue or pull request belongs to the Docs Content team label Jul 10, 2024
Copy link

welcome bot commented Jul 10, 2024

Thanks for opening this issue. 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 Jul 10, 2024
@nguyenalex836 nguyenalex836 added packages This issue or pull request should be reviewed by the docs packages team and removed triage Do not begin working on this issue until triaged by the team labels Jul 10, 2024
@nguyenalex836
Copy link
Contributor

@syntastical Thank you for opening an issue and linking it to your PR! ✨

@felicitymay
Copy link
Contributor

@syntastical - thanks for raising this issue. It's always good to know when documentation is confusing.

The note that you find confusing is intended to explain that classic PAT can be used to access the package registry, but that fine-grained PATs are not supported. For information about the two types of tokens see: Managing your personal access tokens - GitHub Docs.

I think that the best solution here would be to update the text of the file that contains the note, rather than to delete the reference to the note: https://github.com/github/docs/blob/main/data/reusables/package_registry/packages-classic-pat-only.md?plain=1

I suggest that this amendment would be clearer. What do you think?

{% data variables.product.prodname_registry %} supports authentication using a {% data variables.product.pat_v1 %}. Authentication using {% data variables.product.pat_v2_plural %} is not supported. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."

Which should look like this:

GitHub Packages supports authentication using a personal access token (classic). Authentication using fine-grained personal access tokens is not supported. For more information, see "AUTOTITLE."

@felicitymay
Copy link
Contributor

Someone else has raised an issue about this subject too and it's left me wondering what the accurate answer is here. I'm going to tag this for review by a subject matter expert.

@felicitymay felicitymay added the needs SME This proposal needs review from a subject matter expert label Jul 16, 2024
Copy link
Contributor

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

@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR more-information-needed More information is needed to complete review and removed needs SME This proposal needs review from a subject matter expert help wanted Anyone is welcome to open a pull request to fix this issue labels Jul 19, 2024
@nguyenalex836
Copy link
Contributor

@syntastical Hello! 👋 We received confirmation from an SME that GitHub Packages supports the legacy PAT and GITHUB_TOKEN, but no fine-grained access tokens.

Once you have updated your PR with the guidance @felicitymay provided above, we will be happy to get your PR merged 💛

@syntastical
Copy link
Author

@nguyenalex836 sounds good, sorry I've been away. I'll circle back to this ASAP.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Aug 7, 2024
Copy link
Contributor

github-actions bot commented Aug 7, 2024

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further. See this blog post on bug reports and the importance of repro steps for more information about the kind of information that may be helpful.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Aug 7, 2024
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 more-information-needed More information is needed to complete review packages This issue or pull request should be reviewed by the docs packages team SME reviewed An SME has reviewed this issue/PR stale There is no recent activity on this issue or pull request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@felicitymay @syntastical @nguyenalex836 and others