chore: update repo-metadata and regenerate README from templates (#50)

googleapis · Feb 4, 2020 · b9fefd3 · b9fefd3
1 parent b80c0fc
commit b9fefd3
Show file tree

Hide file tree

Showing 4 changed files with 126 additions and 108 deletions.
diff --git a/.repo-metadata.json b/.repo-metadata.json
@@ -2,12 +2,15 @@
   "name": "redis",
   "name_pretty": "Cloud Redis",
   "product_documentation": "https://cloud.google.com/memorystore/docs/redis/",
-  "client_documentation": "https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/redis/v1/package-summary.html",
+  "client_documentation": "https://googleapis.dev/java/google-cloud-redis/latest/",
   "issue_tracker": "https://issuetracker.google.com/savedsearches/5169231",
   "release_level": "beta",
   "language": "java",
   "repo": "googleapis/java-redis",
   "repo_short": "java-redis",
   "distribution_name": "com.google.cloud:google-cloud-redis",
-  "api_id": "redis.googleapis.com"
+  "api_id": "redis.googleapis.com",
+  "transport": "grpc",
+  "requires_billing": true,
+  "api_description": "is a fully managed Redis service for the Google Cloud. Applications running on Google Cloud can achieve extreme performance by leveraging the highly scalable, available, secure Redis service without the burden of managing complex Redis deployments."
 }
diff --git a/README.md b/README.md
@@ -1,48 +1,52 @@
-Google Cloud Java Client for Redis
-==================================
+# Google Cloud Redis Client for Java
 
-Java idiomatic client for [Cloud Memorystore for Redis][cloud-redis].
+Java idiomatic client for [Cloud Redis][product-docs].
 
-[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
-[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-redis.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-redis.svg)
-[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
+[![Maven][maven-version-image]][maven-version-link]
+![Stability][stability-image]
 
-- [Product Documentation][redis-product-docs]
-- [Client Library Documentation][redis-client-lib-docs]
+- [Product Documentation][product-docs]
+- [Client Library Documentation][javadocs]
 
 > Note: This client is a work-in-progress, and may occasionally
 > make backwards-incompatible changes.
 
-Quickstart
-----------
-If you are using Maven with a BOM, add this to your pom.xml file.
+## Quickstart
+
+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>2.8.0</version>
-    <type>pom</type>
-    <scope>import</scope>
-   </dependency>
- </dependencies>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>libraries-bom</artifactId>
+      <version>3.5.0</version>
+      <type>pom</type>
+      <scope>import</scope>
+    </dependency>
+  </dependencies>
 </dependencyManagement>
 
-<dependency>
-  <groupId>com.google.cloud</groupId>
-  <artifactId>google-cloud-redis</artifactId>
-</dependency>
+<dependencies>
+  <dependency>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-redis</artifactId>
+  </dependency>
+</dependencies>
 ```
+
 [//]: # ({x-version-update-start:google-cloud-redis:released})
-If you are using Maven without a BOM, add this to your dependencies.
+
+If you are using Maven without BOM, add this to your dependencies:
+
 ```xml
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-redis</artifactId>
   <version>0.118.0</version>
 </dependency>
 ```
+
 If you are using Gradle, add this to your dependencies
 ```Groovy
 compile 'com.google.cloud:google-cloud-redis:0.118.0'
@@ -53,81 +57,105 @@ libraryDependencies += "com.google.cloud" % "google-cloud-redis" % "0.118.0"
 ```
 [//]: # ({x-version-update-end})
 
-Authentication
---------------
+## Authentication
 
-See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
+See the [Authentication][authentication] section in the base directory's README.
 
-About Cloud Memorystore for Redis
---------------------------
+## Getting Started
 
-[Cloud Memorystore for Redis API][cloud-redis] transfers data from partner
-SaaS applications to Google BigQuery on a scheduled, managed basis.
+### Prerequisites
 
-See the [Cloud Memorystore for Redis client library docs][redis-client-lib-docs] to learn how to interact with the
-Cloud Redis using this Client Library.
-
-Getting Started
----------------
-#### Prerequisites
-For this tutorial, you will need a
-[Google Developers Console](https://console.developers.google.com/) project with the Cloud Memorystore for Redis API
-enabled. You will need to [enable billing](https://support.google.com/cloud/answer/6158867?hl=en) to
-use Google Cloud Redis.
-[Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your
-project set up. You will also need to set up the local development environment by [installing the
-Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line:
+You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Redis [API enabled][enable-api].
+You will need to [enable billing][enable-billing] to use Google Cloud Redis.
+[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
+[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
 `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
 
-#### Installation and setup
+### Installation and setup
+
 You'll need to obtain the `google-cloud-redis` library.  See the [Quickstart](#quickstart) section
 to add `google-cloud-redis` as a dependency in your code.
 
-Transport
----------
-Cloud Memorystore for Redis uses gRPC for the transport layer.
+## About Cloud Redis
 
-Java Versions
--------------
 
-Java 7 or above is required for using this client.
+[Cloud Redis][product-docs] is a fully managed Redis service for the Google Cloud. Applications running on Google Cloud can achieve extreme performance by leveraging the highly scalable, available, secure Redis service without the burden of managing complex Redis deployments.
 
-Testing
--------
+See the [Cloud Redis client library docs][javadocs] to learn how to
+use this Cloud Redis Client Library.
 
-This library has tools to help make tests for code using Cloud Memorystore for Redis.
 
-See [TESTING] to read more about testing.
 
-Versioning
-----------
 
-This library follows [Semantic Versioning](http://semver.org/).
+## Troubleshooting
 
-It is currently in major version zero (``0.y.z``), which means that anything
-may change at any time and the public API should not be considered
-stable.
+To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
 
-Contributing
-------------
+## Transport
 
-Contributions to this library are always welcome and highly encouraged.
+Cloud Redis uses gRPC for the transport layer.
+
+## Java Versions
+
+Java 7 or above is required for using this client.
+
+## Versioning
+
+This library follows [Semantic Versioning](http://semver.org/).
 
-See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
 
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information.
+It is currently in major version zero (``0.y.z``), which means that anything may change at any time
+and the public API should not be considered stable.
 
-License
--------
 
-Apache 2.0 - See [LICENSE] for more information.
+## Contributing
 
 
-[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
-[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
-[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
-[TESTING]: https://github.com/googleapis/google-cloud-java/blob/master/TESTING.md#testing-code-that-uses-redis
+Contributions to this library are always welcome and highly encouraged.
 
-[cloud-redis]: https://cloud.google.com/memorystore/
-[redis-product-docs]: https://cloud.google.com/memorystore/docs/redis/
-[redis-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/redis/v1/package-summary.html
+See [CONTRIBUTING][contributing] for more information how to get started.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in
+this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
+information.
+
+## License
+
+Apache 2.0 - See [LICENSE][license] for more information.
+
+## CI Status
+
+Java Version | Status
+------------ | ------
+Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
+Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
+Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
+Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
+Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
+
+[product-docs]: https://cloud.google.com/memorystore/docs/redis/
+[javadocs]: https://googleapis.dev/java/google-cloud-redis/latest/
+[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java7.svg
+[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java7.html
+[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8.svg
+[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8.html
+[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8-osx.svg
+[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8-osx.html
+[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8-win.svg
+[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java8-win.html
+[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java11.svg
+[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-redis/java11.html
+[stability-image]: https://img.shields.io/badge/stability-beta-yellow
+[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-redis.svg
+[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-redis&core=gav
+[authentication]: https://github.com/googleapis/google-cloud-java#authentication
+[developer-console]: https://console.developers.google.com/
+[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
+[cloud-sdk]: https://cloud.google.com/sdk/
+[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
+[contributing]: https://github.com/googleapis/java-redis/blob/master/CONTRIBUTING.md
+[code-of-conduct]: https://github.com/googleapis/java-redis/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
+[license]: https://github.com/googleapis/java-redis/blob/master/LICENSE
+[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
+[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=redis.googleapis.com
+[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
diff --git a/synth.metadata b/synth.metadata
@@ -1,5 +1,5 @@
 {
-  "updateTime": "2020-02-01T08:58:24.011830Z",
+  "updateTime": "2020-02-03T23:20:17.869807Z",
   "sources": [
     {
       "generator": {
@@ -12,9 +12,9 @@
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "b5cbe4a4ba64ab19e6627573ff52057a1657773d",
-        "internalRef": "292647187",
-        "log": "b5cbe4a4ba64ab19e6627573ff52057a1657773d\nSecurityCenter v1p1beta1: move file-level option on top to workaround protobuf.js bug.\n\nPiperOrigin-RevId: 292647187\n\nb224b317bf20c6a4fbc5030b4a969c3147f27ad3\nAdds API definitions for bigqueryreservation v1beta1.\n\nPiperOrigin-RevId: 292634722\n\nc1468702f9b17e20dd59007c0804a089b83197d2\nSynchronize new proto/yaml changes.\n\nPiperOrigin-RevId: 292626173\n\nffdfa4f55ab2f0afc11d0eb68f125ccbd5e404bd\nvision: v1p3beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292605599\n\n78f61482cd028fc1d9892aa5d89d768666a954cd\nvision: v1p1beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292605125\n\n60bb5a294a604fd1778c7ec87b265d13a7106171\nvision: v1p2beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292604980\n\n3bcf7aa79d45eb9ec29ab9036e9359ea325a7fc3\nvision: v1p4beta1 publish annotations and retry config\n\nPiperOrigin-RevId: 292604656\n\n2717b8a1c762b26911b45ecc2e4ee01d98401b28\nFix dataproc artman client library generation.\n\nPiperOrigin-RevId: 292555664\n\n"
+        "sha": "29d40b78e3dc1579b0b209463fbcb76e5767f72a",
+        "internalRef": "292979741",
+        "log": "29d40b78e3dc1579b0b209463fbcb76e5767f72a\nExpose managedidentities/v1beta1/ API for client library usage.\n\nPiperOrigin-RevId: 292979741\n\na22129a1fb6e18056d576dfb7717aef74b63734a\nExpose managedidentities/v1/ API for client library usage.\n\nPiperOrigin-RevId: 292968186\n\n"
       }
     },
     {

diff --git a/synth.py b/synth.py
@@ -25,29 +25,16 @@
 config_pattern = '/google/cloud/redis/artman_redis_{version}.yaml'
 
 for version in versions:
-    library = gapic.java_library(
-        service=service,
-        version=version,
-        config_path=config_pattern.format(version=version),
-        artman_output_name='')
-
-    package_name = f'com.google.cloud.{service}.{version}'
-    java.fix_proto_headers(library / f'proto-google-cloud-{service}-{version}')
-    java.fix_grpc_headers(library / f'grpc-google-cloud-{service}-{version}', package_name)
-
-    s.copy(library / f'gapic-google-cloud-{service}-{version}/src', f'google-cloud-{service}/src')
-    s.copy(library / f'grpc-google-cloud-{service}-{version}/src', f'grpc-google-cloud-{service}-{version}/src')
-    s.copy(library / f'proto-google-cloud-{service}-{version}/src', f'proto-google-cloud-{service}-{version}/src')
-
-    java.format_code(f'google-cloud-{service}/src')
-    java.format_code(f'grpc-google-cloud-{service}-{version}/src')
-    java.format_code(f'proto-google-cloud-{service}-{version}/src')
-
-common_templates = gcp.CommonTemplates()
-templates = common_templates.java_library()
-s.copy(templates, excludes=[
-    'README.md',
-    '.kokoro/continuous/integration.cfg',
-    '.kokoro/nightly/integration.cfg',
-    '.kokoro/presubmit/integration.cfg'
+  java.gapic_library(
+    service=service,
+    version=version,
+    config_pattern=config_pattern,
+    package_pattern='com.google.cloud.{service}.{version}',
+    gapic=gapic,
+  )
+
+java.common_templates(excludes=[
+  '.kokoro/continuous/integration.cfg',
+  '.kokoro/nightly/integration.cfg',
+  '.kokoro/presubmit/integration.cfg'
 ])