From e85f9683db0ce9600c4bbbaa9f38334382fe62e3 Mon Sep 17 00:00:00 2001 From: Yannic Date: Tue, 20 Feb 2024 14:49:38 -0800 Subject: [PATCH] [credentialhelper] Update flag doc to point to more convenient usage instructions Arguably, we should have a dedicated page for this on `bazel.build`, but until we have that, this post seems like a better source for users than the original design doc. Closes #21382. PiperOrigin-RevId: 608747673 Change-Id: Iaca0dc8364a6d622f685bdd53eea54068c4ea94c --- .../build/lib/authandtls/AuthAndTLSOptions.java | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java b/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java index 2f97d3b8a77d42..1e1ff53d910261 100644 --- a/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java +++ b/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java @@ -148,15 +148,17 @@ public class AuthAndTLSOptions extends OptionsBase { documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, effectTags = {OptionEffectTag.UNKNOWN}, help = - "Configures a credential helper to use for retrieving authorization credentials for " - + " repository fetching, remote caching and execution, and the build event" - + " service.\n\n" + "Configures a credential helper conforming to the Credential Helper" + + " Specification 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 credentialHelpers; @Option(