Skip to content

Commit 463159e

Browse files
lqiu96lqiu96
authored
Merge branch 'main' into readme-warning
2 parents b3afcf5 + fc20d9c commit 463159e

File tree

5 files changed

+137
-8
lines changed

5 files changed

+137
-8
lines changed

‎.github/workflows/members.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[
2+
{"login":"suztomo"},
3+
{"login":"dangazineu"},
4+
{"login":"ldetmer"},
5+
{"login":"zhumin8"},
6+
{"login":"blakeli0"},
7+
{"login":"lqiu96"},
8+
{"login":"jinseopkim0"},
9+
{"login":"meltsufin"},
10+
{"login":"diegomarquezp"},
11+
{"login":"burkedavison"},
12+
{"login":"mpeddada1"},
13+
{"login":"JoeWang1127"},
14+
{"login":"kmaydeo"},
15+
{"login":"lsirac"},
16+
{"login":"aeitzman"}
17+
]

‎.github/workflows/multi_approvers.yaml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 'multi-approvers'
2+
3+
on:
4+
pull_request:
5+
types:
6+
- 'opened'
7+
- 'edited'
8+
- 'reopened'
9+
- 'synchronize'
10+
- 'ready_for_review'
11+
- 'review_requested'
12+
- 'review_request_removed'
13+
pull_request_review:
14+
types:
15+
- 'submitted'
16+
- 'dismissed'
17+
18+
permissions:
19+
actions: 'write'
20+
contents: 'read'
21+
pull-requests: 'read'
22+
23+
concurrency:
24+
group: '${{ github.workflow }}-${{ github.head_ref || github.ref }}'
25+
cancel-in-progress: true
26+
27+
jobs:
28+
multi-approvers:
29+
uses: 'abcxyz/pkg/.github/workflows/multi-approvers.yml@main'
30+
with:
31+
org-members-path: '.github/workflows/members.json'

‎.release-please-manifest.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "1.30.1"
3+
}

‎README.md‎

Lines changed: 65 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,35 +55,92 @@ information, refer to [documentation](https://cloud.google.com/docs/authenticati
5555

5656
## Quickstart
5757

58+
### Preferred method: using `java-libraries-bom`
59+
If your use case is to enable authentication for a GAPIC library such as `google-cloud-datastore`,
60+
you may want simply add `libraries-bom`, which automatically imports the auth bom, to your pom.xml
61+
as follows:
62+
63+
[//]: # ({x-version-update-start:google-auth-library-bom:released})
64+
```xml
65+
<dependencyManagement>
66+
<dependencies>
67+
<dependency>
68+
<groupId>com.google.cloud</groupId>
69+
<artifactId>libraries-bom</artifactId>
70+
<version>26.53.0</version>
71+
<type>pom</type>
72+
<scope>import</scope>
73+
</dependency>
74+
</dependencies>
75+
</dependencyManagement>
76+
```
77+
78+
Otherwise, if you don't plan using libraries-bom, see the next section on
79+
_Google Auth Library Bill of Materials_.
80+
81+
### Using Maven
82+
83+
#### Google Auth Library Bill of Materials
84+
In order to ensure transitive dependencies and the modules themselves are aligned with each other,
85+
we rely on the Google Auth Library Bill of Materials. Please add this to your dependency management
86+
section as follows:
87+
88+
[//]: # ({x-version-update-start:google-auth-library-bom:released})
89+
```xml
90+
<dependencyManagement>
91+
<dependencies>
92+
<dependency>
93+
<groupId>com.google.auth</groupId>
94+
<artifactId>google-auth-library-bom</artifactId>
95+
<version>1.30.1</version>
96+
<type>pom</type>
97+
<scope>import</scope>
98+
</dependency>
99+
</dependencies>
100+
</dependencyManagement>
101+
```
102+
[//]: # ({x-version-update-end})
103+
104+
#### Choosing your implementation
105+
58106
If you are using Maven, add this to your pom.xml file (notice that you can replace
59107
`google-auth-library-oauth2-http` with any of `google-auth-library-credentials` and
60108
`google-auth-library-appengine`, depending on your application needs):
61109

62-
[//]: # ({x-version-update-start:google-auth-library-oauth2-http:released})
63-
64110
```xml
65111
<dependency>
66112
<groupId>com.google.auth</groupId>
113+
<!-- Let the BOM manage the module and dependency versions -->
114+
<!-- Replace with the module(s) that are needed -->
67115
<artifactId>google-auth-library-oauth2-http</artifactId>
68-
<version>1.19.0</version>
69116
</dependency>
70117
```
71-
[//]: # ({x-version-update-end})
72-
73118

119+
### Using Gradle
74120
If you are using Gradle, add this to your dependencies
75121

76-
[//]: # ({x-version-update-start:google-auth-library-oauth2-http:released})
122+
[//]: # ({x-version-update-start:google-auth-library-bom:released})
77123
```Groovy
78-
implementation 'com.google.auth:google-auth-library-oauth2-http:1.19.0'
124+
dependencies {
125+
// The BOM will manage the module versions and transitive dependencies
126+
implementation platform('com.google.auth:google-auth-library-bom:1.30.1')
127+
// Replace with the module(s) that are needed
128+
implementation 'com.google.auth:google-auth-library-oauth2-http'
129+
}
130+
79131
```
80132
[//]: # ({x-version-update-end})
81133

134+
Unfortunately, SBT [cannot](https://github.com/sbt/sbt/issues/4531) manage dependencies via Maven
135+
Bills of Materials. Therefore, you will have to add the submodule directly. Make sure the module
136+
versions are aligned in case you are using more than one authentication module in order to prevent
137+
transitive dependency conflicts.
82138
If you are using SBT, add this to your dependencies
83139

84140
[//]: # ({x-version-update-start:google-auth-library-oauth2-http:released})
85141
```Scala
86-
libraryDependencies += "com.google.auth" % "google-auth-library-oauth2-http" % "1.19.0"
142+
// Replace this with the implementation module that suits your needs
143+
libraryDependencies += "com.google.auth" % "google-auth-library-oauth2-http" % "1.30.1"
87144
```
88145
[//]: # ({x-version-update-end})
89146

‎release-please-config.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"release-type": "java-yoshi-mono-repo",
3+
"separate-pull-requests": false,
4+
"include-component-in-tag": false,
5+
"group-pull-request-title-pattern": "chore(${branch}): release ${version}",
6+
"packages": {
7+
".": {
8+
"changelog-path": "CHANGELOG.md",
9+
"release-type": "java-yoshi",
10+
"bump-minor-pre-major": false,
11+
"bump-patch-for-minor-pre-major": false,
12+
"draft": false,
13+
"prerelease": false,
14+
"extra-files": [
15+
"README.md",
16+
"bom/README.md"
17+
]
18+
}
19+
},
20+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
21+
}

0 commit comments

Comments
 (0)