docs: promote use of bill of materials in quickstart documentation #1620
+65
−8
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,35 +50,92 @@ credentials as well as utility methods to create them and to get Application Def | |
|
|
||
| ## Quickstart | ||
|
|
||
| ### Alternative: using `java-libraries-bom` | ||
| If your use case is to enable authentication for a GAPIC library such as `google-cloud-datastore`, | ||
| you may want simply add `libraries-bom`, which automatically imports the auth bom, to your pom.xml | ||
| as follows: | ||
|
|
||
| [//]: # ({x-version-update-start:google-auth-library-bom:released}) | ||
| ```xml | ||
| <dependencyManagement> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>libraries-bom</artifactId> | ||
| <version>26.53.0</version> | ||
| <type>pom</type> | ||
| <scope>import</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| </dependencyManagement> | ||
| ``` | ||
|
|
||
| Otherwise, if you don't plan using libraries-bom, see the next section on | ||
| _Google Auth Library Bill of Materials_. | ||
|
|
||
| ### 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 Other repos such as google-cloud-java use the config yaml. 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 |
||
|
|
||
| #### Google Auth Library Bill of Materials | ||
| In order to ensure transitive dependencies and the modules themselves are aligned with each other, | ||
| we rely on the Google Auth Library Bill of Materials. Please add this to your dependency management | ||
| section as follows: | ||
|
|
||
| [//]: # ({x-version-update-start:google-auth-library-bom:released}) | ||
| ```xml | ||
| <dependencyManagement> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.google.auth</groupId> | ||
| <artifactId>google-auth-library-bom</artifactId> | ||
| <version>1.30.1</version> | ||
lqiu96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <type>pom</type> | ||
| <scope>import</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| </dependencyManagement> | ||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
| #### Choosing your implementation | ||
|
|
||
| If you are using Maven, add this to your pom.xml file (notice that you can replace | ||
| `google-auth-library-oauth2-http` with any of `google-auth-library-credentials` and | ||
| `google-auth-library-appengine`, depending on your application needs): | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>com.google.auth</groupId> | ||
| <!-- Let the BOM manage the transitive dependencies and module version. --> | ||
diegomarquezp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <!-- Replace with the module(s) that are needed --> | ||
| <artifactId>google-auth-library-oauth2-http</artifactId> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| ### Using Gradle | ||
| If you are using Gradle, add this to your dependencies | ||
|
|
||
| [//]: # ({x-version-update-start:google-auth-library-bom:released}) | ||
| ```Groovy | ||
| dependencies { | ||
| // The BOM will manage the module versions and transitive dependencies | ||
| implementation platform('com.google.auth:google-auth-library-bom:1.30.1') | ||
lqiu96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Replace with the module(s) that are needed | ||
| implementation 'com.google.auth:google-auth-library-oauth2-http' | ||
| } | ||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
| Unfortunately, SBT [cannot](https://github.com/sbt/sbt/issues/4531) manage dependencies via Maven | ||
| Bills of Materials. Therefore, you will have to add the submodule directly. Make sure the module | ||
| versions are aligned in case you are using more than one authentication module in order to prevent | ||
| transitive dependency conflicts. | ||
| If you are using SBT, add this to your dependencies | ||
|
|
||
| [//]: # ({x-version-update-start:google-auth-library-oauth2-http:released}) | ||
| ```Scala | ||
| // Replace this with the implementation module that suits your needs | ||
| libraryDependencies += "com.google.auth" % "google-auth-library-oauth2-http" % "1.30.1" | ||
lqiu96 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps not as
alternativesince it's the first option listed. I think we can probably put something likePreferred/ Preference?