docs: Update readme to include gradle instructions for storage control (

#2503) * docs: Update readme to include gradle instructions for storage control * address pr comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Move storage control installation instruction to partials template, add partials template to release please * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * review comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Jesse Lovelace <[email protected]>
googleapis · Apr 24, 2024 · 50ac93b · 50ac93b
1 parent 87b63f4
commit 50ac93b
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 0 deletions.
diff --git a/.github/release-please.yml b/.github/release-please.yml
@@ -3,6 +3,7 @@ handleGHRelease: true
 releaseType: java-yoshi
 extraFiles:
   - README.md
+  - .readme-partials.yaml
 branches:
   - bumpMinorPreMajor: true
     handleGHRelease: true

diff --git a/.readme-partials.yaml b/.readme-partials.yaml
@@ -5,6 +5,48 @@ custom_content: |
   
   The Storage Control API creates one space to perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.
   
+  If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
+  ```xml
+  <dependencyManagement>
+      <dependencies>
+          <dependency>
+              <groupId>com.google.cloud</groupId>
+              <artifactId>libraries-bom</artifactId>
+              <version>26.37.0</version>
+              <type>pom</type>
+              <scope>import</scope>
+          </dependency>
+      </dependencies>
+  </dependencyManagement>
+  
+  <dependencies>
+      <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-storage-control</artifactId>
+  </dependency>
+  ```
+  
+  If you are using Maven without the BOM, add this to your dependencies:
+  <!-- {x-version-update-start:google-cloud-storage:released} -->
+  ```xml
+  <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-storage-control</artifactId>
+      <version>2.36.1-alpha</version><!-- {x-version-update:google-cloud-storage:released} -->
+  </dependency>
+  ```
+  
+  If you are using Gradle 5.x or later, add this to your dependencies:
+  ```Groovy
+  implementation platform('com.google.cloud:libraries-bom:26.37.0')
+  implementation 'com.google.cloud:google-cloud-storage-control'
+  ```
+  If you are using Gradle without BOM, add this to your dependencies:
+  
+  ```Groovy
+  implementation 'com.google.cloud:google-cloud-storage-control:2.36.1-alpha' <!-- {x-version-update:google-cloud-storage:released} -->
+  ```
+  
   #### Creating an authorized service object
 
   To make authenticated requests to Google Cloud Storage, you must create a service object with credentials. You can

diff --git a/README.md b/README.md
@@ -114,6 +114,48 @@ The [Storage Control API](https://cloud.google.com/storage/docs/reference/rpc/)
 
 The Storage Control API creates one space to perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.
 
+If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
+```xml
+<dependencyManagement>
+    <dependencies>
+        <dependency>
+            <groupId>com.google.cloud</groupId>
+            <artifactId>libraries-bom</artifactId>
+            <version>26.37.0</version>
+            <type>pom</type>
+            <scope>import</scope>
+        </dependency>
+    </dependencies>
+</dependencyManagement>
+
+<dependencies>
+    <dependency>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-storage-control</artifactId>
+</dependency>
+```
+
+If you are using Maven without the BOM, add this to your dependencies:
+<!-- {x-version-update-start:google-cloud-storage:released} -->
+```xml
+<dependency>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-storage-control</artifactId>
+    <version>2.36.1-alpha</version><!-- {x-version-update:google-cloud-storage:released} -->
+</dependency>
+```
+
+If you are using Gradle 5.x or later, add this to your dependencies:
+```Groovy
+implementation platform('com.google.cloud:libraries-bom:26.37.0')
+implementation 'com.google.cloud:google-cloud-storage-control'
+```
+If you are using Gradle without BOM, add this to your dependencies:
+
+```Groovy
+implementation 'com.google.cloud:google-cloud-storage-control:2.36.1-alpha' <!-- {x-version-update:google-cloud-storage:released} -->
+```
+
 #### Creating an authorized service object
 
 To make authenticated requests to Google Cloud Storage, you must create a service object with credentials. You can