docs: promote use of bill of materials in quickstart documentation #1620
Conversation
| @@ -50,35 +50,69 @@ credentials as well as utility methods to create them and to get Application Def | |||
|
|
|||
| ## Quickstart | |||
|
|
|||
| ### Using Maven | |||
There was a problem hiding this comment.
Thanks!
Thoughts on also mentioning libraries-bom here (perhaps a small section)? We can mention that if you use libraries-bom, then auth-bom is imported as well.
Otherwise, you should manually import the auth-bom (like below)
There was a problem hiding this comment.
Sounds good. I'll add a section.
There was a problem hiding this comment.
Ah, I think it's not as trivial to ensure the snippet with libraries-bom has an up-to-date <version/> since it's not managed in versions.txt.
Other repos such as google-cloud-java use the config yaml.
We also have the case of spring-cloud-gcp which seems to rely on renovate-bot. I think it's better to wait for such PR and otherwise raise an issue to keep it up to date.
There was a problem hiding this comment.
Ah yeah makes sense. Maybe we don't need to have a code reference here. We could just reference this page: https://cloud.google.com/java/docs/bom
Co-authored-by: Lawrence Qiu <[email protected]>
Co-authored-by: Lawrence Qiu <[email protected]>
There was a problem hiding this comment.
@lqiu96 thanks for the comments. Just for clarity, #1616 (review) was pretty much to ensure these versions in our READMEs get updated properly by release-please
|
| @@ -50,35 +50,92 @@ credentials as well as utility methods to create them and to get Application Def | |||
|
|
|||
| ## Quickstart | |||
|
|
|||
| ### Alternative: using `java-libraries-bom` | |||
There was a problem hiding this comment.
Perhaps not as alternative since it's the first option listed. I think we can probably put something like Preferred/ Preference?
| ```xml | ||
| <dependency> | ||
| <groupId>com.google.auth</groupId> | ||
| <!-- Let the BOM manage the transitive dependencies and module version. --> |
There was a problem hiding this comment.
| <!-- Let the BOM manage the transitive dependencies and module version. --> | |
| <!-- Let the BOM manage the module and dependency versions --> |
Fixes #1552