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.

Sign up for GitHub

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

[credentialhelper] Update flag doc to point to more convenient usage instructions #21382

Closed
wants to merge 2 commits into from
Closed

[credentialhelper] Update flag doc to point to more convenient usage instructions #21382

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aebb052
[credentialhelper] Update flag doc to point to more convenient usage …
Yannic Feb 16, 2024
4c570d5
link spec
Yannic Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,14 @@ public class AuthAndTLSOptions extends OptionsBase {
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
effectTags = {OptionEffectTag.UNKNOWN},
help =
"Configures a credential helper to use for retrieving authorization credentials for "
"Configures a credential helper conforming to the <a href=\"https://github.com/EngFlow/credential-helper-spec\">Credential Helper Specification</a> to use for retrieving authorization credentials for "
+ " repository fetching, remote caching and execution, and the build event"
+ " service.\n\n"
+ "Credentials supplied by a helper take precedence over credentials supplied by"
+ " --google_default_credentials, --google_credentials, a .netrc file, or the auth"
+ " parameter to repository_ctx.download and repository_ctx.download_and_extract.\n\n"
+ " `--google_default_credentials`, `--google_credentials`, a `.netrc` file, or the auth"
+ " parameter to `repository_ctx.download()` and `repository_ctx.download_and_extract()`.\n\n"
+ "May be specified multiple times to set up multiple helpers.\n\n"
+ "See https://github.com/bazelbuild/proposals/blob/main/designs/2022-06-07-bazel-credential-helpers.md"
+ " for details.")
+ "See https://blog.engflow.com/2023/10/09/configuring-bazels-credential-helper/ for instructions.")
public List<CredentialHelperOption> credentialHelpers;

@Option(
Expand Down
Loading