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

Commit 2a723df

Browse files
fix: owlbot post-processor should generate README (#1154) (#34)
Fixes #1146 Fixes #1147 Source-Link: googleapis/synthtool@387851d Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec
1 parent e165ed9 commit 2a723df

File tree

2 files changed

+64
-20
lines changed

2 files changed

+64
-20
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: 63 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cloud Shell Client for Java
1+
# Google Cloud Shell Client for Java
22

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

@@ -8,9 +8,6 @@ Java idiomatic client for [Cloud Shell][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11-
> Note: This client is a work-in-progress, and may occasionally
12-
> make backwards-incompatible changes.
13-
1411
## Quickstart
1512

1613

@@ -20,18 +17,19 @@ If you are using Maven, add this to your pom.xml file:
2017
<dependency>
2118
<groupId>com.google.cloud</groupId>
2219
<artifactId>google-cloud-shell</artifactId>
23-
<version>0.0.0</version>
20+
<version>1.0.0</version>
2421
</dependency>
22+
2523
```
2624

2725
If you are using Gradle without BOM, add this to your dependencies
2826
```Groovy
29-
compile 'com.google.cloud:google-cloud-shell:0.0.0'
27+
compile 'com.google.cloud:google-cloud-shell:1.0.0'
3028
```
3129

3230
If you are using SBT, add this to your dependencies
3331
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-shell" % "0.0.0"
32+
libraryDependencies += "com.google.cloud" % "google-cloud-shell" % "1.0.0"
3533
```
3634

3735
## Authentication
@@ -43,7 +41,7 @@ See the [Authentication][authentication] section in the base directory's README.
4341
### Prerequisites
4442

4543
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Shell [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use Cloud Shell.
44+
You will need to [enable billing][enable-billing] to use Google Cloud Shell.
4745
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4846
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4947
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -56,13 +54,16 @@ to add `google-cloud-shell` as a dependency in your code.
5654
## About Cloud Shell
5755

5856

59-
[Cloud Shell][product-docs] is an interactive shell environment for Google Cloud
60-
that makes it easy for you to learn and experiment with Google Cloud and manage
61-
your projects and resources from your web browser.
57+
[Cloud Shell][product-docs] is an interactive shell environment for Google Cloud that makes it easy for you to learn and experiment with Google Cloud and manage your projects and resources from your web browser.
6258

6359
See the [Cloud Shell client library docs][javadocs] to learn how to
6460
use this Cloud Shell Client Library.
6561

62+
63+
64+
65+
66+
6667
## Troubleshooting
6768

6869
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -71,19 +72,56 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
7172

7273
Cloud Shell uses gRPC for the transport layer.
7374

74-
## Java Versions
75+
## Supported Java Versions
7576

7677
Java 7 or above is required for using this client.
7778

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

80121

81122
This library follows [Semantic Versioning](http://semver.org/).
82123

83124

84-
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
85-
and the public API should not be considered stable.
86-
87125
## Contributing
88126

89127

@@ -111,7 +149,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
111149

112150
Java is a registered trademark of Oracle and/or its affiliates.
113151

114-
[product-docs]: https://cloud.google.com/shell/docs/
152+
[product-docs]: https://cloud.google.com/shell/docs
115153
[javadocs]: https://googleapis.dev/java/google-cloud-shell/latest/index.html
116154
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java7.svg
117155
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java7.html
@@ -123,7 +161,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
123161
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java8-win.html
124162
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java11.svg
125163
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java11.html
126-
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
164+
[stability-image]: https://img.shields.io/badge/stability-ga-green
127165
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-shell.svg
128166
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-shell&core=gav
129167
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
@@ -135,6 +173,12 @@ Java is a registered trademark of Oracle and/or its affiliates.
135173
[code-of-conduct]: https://github.com/googleapis/java-shell/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
136174
[license]: https://github.com/googleapis/java-shell/blob/master/LICENSE
137175
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
138-
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=shell.googleapis.com
176+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudshell.googleapis.com
139177
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
140-
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
178+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
179+
180+
[semver]: https://semver.org/
181+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
182+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
183+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
184+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)