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

designs/2022-06-07-bazel-credential-helpers.md says request has "url", but bazel uses "uri" #327

Open
ukai opened this issue Jul 26, 2023 · 2 comments

Comments

@ukai
Copy link

ukai commented Jul 26, 2023

https://github.com/bazelbuild/proposals/blob/main/designs/2022-06-07-bazel-credential-helpers.md

get: Retrieves credentials. The payload provided as standard input to the credential helper will be a json object with a single key url containing the url (including the protocol) to get credentials for ({"url": "..."}).

but
https://github.com/bazelbuild/bazel/blob/c00e8e623b717ecb734feeeb8f268af718b95683/src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper/GetCredentialsRequest.java#L66

  writer.name("uri").value(value.getUri().toString());
@tjgq
Copy link
Contributor

tjgq commented Jul 26, 2023

Thanks, I've sent #328 to fix the example in the proposal.

More importantly, we need better user-facing documentation on how to write a credential helper - note that proposals only describe the initial design for a feature and are not supposed to be kept up to date as the implementation evolves, but in the case of credential helpers the documentation is lacking, so your expectation that the proposal should be up to date is reasonable.

@tjgq tjgq changed the title designs/2022-06-07-bazel-credential-helpers.md says request has "url", but bazel uses "uri" Publish a guide on how to write a credential helper Jul 26, 2023
@tjgq tjgq changed the title Publish a guide on how to write a credential helper designs/2022-06-07-bazel-credential-helpers.md says request has "url", but bazel uses "uri" Jul 26, 2023
@ukai
Copy link
Author

ukai commented Jul 27, 2023

thanks!

yeah. the doc is referenced from flag help message.
https://github.com/bazelbuild/bazel/blob/7a262a6ee88e0ecc10705c460e38efe32c8543e2/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java#L159

It would be nice if it points to spec doc, rather than proposals.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants