Skip to content

Commit

Permalink
[credentialhelper] Update flag doc to point to more convenient usage …
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
Yannic authored and copybara-github committed Feb 20, 2024
1 parent c575c06 commit f1b02a2
Showing 1 changed file with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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

0 comments on commit f1b02a2

Please sign in to comment.