Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 2fccf6f

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
fix: owlbot post-processor should generate README (#1154) (#20)
Fixes #1146 Fixes #1147 Source-Link: googleapis/synthtool@387851d Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec
1 parent ff60219 commit 2fccf6f

File tree

2 files changed

+74
-24
lines changed

2 files changed

+74
-24
lines changed

‎.github/.OwlBot.lock.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:2e88a4a7fe3377cf8de1fa5982134f6ef2768980fa2f94edcc1ba6604ae2e7ca
3+
digest: sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec

‎README.md‎

Lines changed: 73 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cloud Debugger Client for Java
1+
# Google Cloud Debugger Client for Java
22

33
Java idiomatic client for [Cloud Debugger][product-docs].
44

@@ -20,18 +20,18 @@ If you are using Maven, add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>google-cloud-debugger-client</artifactId>
23-
<version>0.0.0</version>
23+
<version>0.1.1</version>
2424
</dependency>
2525
```
2626

2727
If you are using Gradle without BOM, add this to your dependencies
2828
```Groovy
29-
compile 'com.google.cloud:google-cloud-debugger-client:0.0.0'
29+
compile 'com.google.cloud:google-cloud-debugger-client:0.1.1'
3030
```
3131

3232
If you are using SBT, add this to your dependencies
3333
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-debugger-client" % "0.0.0"
34+
libraryDependencies += "com.google.cloud" % "google-cloud-debugger-client" % "0.1.1"
3535
```
3636

3737
## Authentication
@@ -43,7 +43,7 @@ See the [Authentication][authentication] section in the base directory's README.
4343
### Prerequisites
4444

4545
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Debugger [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use Cloud Debugger.
46+
You will need to [enable billing][enable-billing] to use Google Cloud Debugger.
4747
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4848
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4949
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -58,10 +58,14 @@ to add `google-cloud-debugger-client` as a dependency in your code.
5858

5959
[Cloud Debugger][product-docs] is a feature of Google Cloud Platform that lets you inspect the state of an application, at any code location, without stopping or slowing down the running app. Cloud Debugger makes it easier to view the application state without adding logging statements.
6060

61-
6261
See the [Cloud Debugger client library docs][javadocs] to learn how to
6362
use this Cloud Debugger Client Library.
6463

64+
65+
66+
67+
68+
6569
## Troubleshooting
6670

6771
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -70,10 +74,50 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
7074

7175
Cloud Debugger uses gRPC for the transport layer.
7276

73-
## Java Versions
77+
## Supported Java Versions
7478

7579
Java 7 or above is required for using this client.
7680

81+
Google's Java client libraries,
82+
[Google Cloud Client Libraries][cloudlibs]
83+
and
84+
[Google Cloud API Libraries][apilibs],
85+
follow the
86+
[Oracle Java SE support roadmap][oracle]
87+
(see the Oracle Java SE Product Releases section).
88+
89+
### For new development
90+
91+
In general, new feature development occurs with support for the lowest Java
92+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
93+
from initial General Availability). If the minimum required JVM for a given
94+
library is changed, it is accompanied by a [semver][semver] major release.
95+
96+
Java 11 and (in September 2021) Java 17 are the best choices for new
97+
development.
98+
99+
### Keeping production systems current
100+
101+
Google tests its client libraries with all current LTS versions covered by
102+
Oracle's Extended Support (which typically lasts 8 years from initial
103+
General Availability).
104+
105+
#### Legacy support
106+
107+
Google's client libraries support legacy versions of Java runtimes with long
108+
term stable libraries that don't receive feature updates on a best efforts basis
109+
as it may not be possible to backport all patches.
110+
111+
Google provides updates on a best efforts basis to apps that continue to use
112+
Java 7, though apps might need to upgrade to current versions of the library
113+
that supports their JVM.
114+
115+
#### Where to find specific information
116+
117+
The latest versions and the supported Java versions are identified on
118+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
119+
and on [google-cloud-java][g-c-j].
120+
77121
## Versioning
78122

79123

@@ -110,18 +154,18 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
110154

111155
Java is a registered trademark of Oracle and/or its affiliates.
112156

113-
[product-docs]: https://cloud.google.com/debugger/docs/
157+
[product-docs]: https://cloud.google.com/debugger/docs
114158
[javadocs]: https://googleapis.dev/java/google-cloud-debugger-client/latest/index.html
115-
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java7.svg
116-
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java7.html
117-
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8.svg
118-
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8.html
119-
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8-osx.svg
120-
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8-osx.html
121-
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8-win.svg
122-
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java8-win.html
123-
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java11.svg
124-
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger/java11.html
159+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java7.svg
160+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java7.html
161+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8.svg
162+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8.html
163+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8-osx.svg
164+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8-osx.html
165+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8-win.svg
166+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java8-win.html
167+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java11.svg
168+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-debugger-client/java11.html
125169
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
126170
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-debugger-client.svg
127171
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-debugger-client&core=gav
@@ -130,10 +174,16 @@ Java is a registered trademark of Oracle and/or its affiliates.
130174
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
131175
[cloud-sdk]: https://cloud.google.com/sdk/
132176
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
133-
[contributing]: https://github.com/googleapis/java-debugger/blob/master/CONTRIBUTING.md
134-
[code-of-conduct]: https://github.com/googleapis/java-debugger/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
135-
[license]: https://github.com/googleapis/java-debugger/blob/master/LICENSE
177+
[contributing]: https://github.com/googleapis/java-debugger-client/blob/master/CONTRIBUTING.md
178+
[code-of-conduct]: https://github.com/googleapis/java-debugger-client/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
179+
[license]: https://github.com/googleapis/java-debugger-client/blob/master/LICENSE
136180
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
137-
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=debugger.googleapis.com
181+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=clouddebugger.googleapis.com
138182
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
139-
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
183+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
184+
185+
[semver]: https://semver.org/
186+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
187+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
188+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
189+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)