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
Add note about ghcr.io for HOMEBREW_DOCKER_REGISTRY_TOKEN #16794
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -165,8 +165,11 @@ module EnvConfig | |||||
"proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead.", | ||||||
}, | ||||||
HOMEBREW_DOCKER_REGISTRY_TOKEN: { | ||||||
description: "Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. " \ | ||||||
"Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.", | ||||||
description: <<~EOS, | ||||||
Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. | ||||||
Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`. | ||||||
EOS | ||||||
default_text: "`QQ==` unless `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN` is set.", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
}, | ||||||
HOMEBREW_EDITOR: { | ||||||
description: "Use this editor when editing a single formula, or several formulae in the " \ | ||||||
|
@@ -239,12 +242,20 @@ module EnvConfig | |||||
default: "git", | ||||||
}, | ||||||
HOMEBREW_GITHUB_API_TOKEN: { | ||||||
description: "Use this personal access token for the GitHub API, for features such as " \ | ||||||
"`brew search`. You can create one at <https://github.com/settings/tokens>. If set, " \ | ||||||
"GitHub will allow you a greater number of API requests. For more information, see: " \ | ||||||
"<https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api>" \ | ||||||
"\n\n *Note:* Homebrew doesn't require permissions for any of the scopes, but some " \ | ||||||
"developer commands may require additional permissions.", | ||||||
description: <<~EOS, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please put this all one one line too. |
||||||
Use this personal access token for the GitHub API, for features such as `brew search`. | ||||||
You can create one at <https://github.com/settings/tokens>. | ||||||
If set, GitHub will allow you a greater number of API requests. | ||||||
For more information, see: "<https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api>" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
*Note:* Homebrew doesn't require permissions for any of the scopes, | ||||||
but some developer commands may require additional permissions. | ||||||
|
||||||
*Note:* If set, this token will also be used to authenticating against `ghcr.io` unless | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Love this, great work! |
||||||
`HOMEBREW_DOCKER_REGISTRY_TOKEN` or `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN` has been set. | ||||||
In this case, the token will require the `packages` permission to be set. | ||||||
`HOMEBREW_GITHUB_PACKAGES_TOKEN` is not used for this permission, but only for uploading packages. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Remove this and move to the |
||||||
EOS | ||||||
}, | ||||||
HOMEBREW_GITHUB_PACKAGES_TOKEN: { | ||||||
description: "Use this GitHub personal access token when accessing the GitHub Packages Registry " \ | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please put this all on one line again, thanks.