From 2a723dfeae11fcd71a0148b2f1d3961ac5682c1b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 14 Jul 2021 21:20:32 +0000 Subject: [PATCH] fix: owlbot post-processor should generate README (#1154) (#34) Fixes #1146 Fixes #1147 Source-Link: https://github.com/googleapis/synthtool/commit/387851d0e88ca4a5b1771ad63d915bed1bd4a740 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec --- .github/.OwlBot.lock.yaml | 2 +- README.md | 82 ++++++++++++++++++++++++++++++--------- 2 files changed, 64 insertions(+), 20 deletions(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 23bcdc9b..18561afe 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -1,3 +1,3 @@ docker: image: gcr.io/repo-automation-bots/owlbot-java:latest - digest: sha256:2e88a4a7fe3377cf8de1fa5982134f6ef2768980fa2f94edcc1ba6604ae2e7ca + digest: sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec diff --git a/README.md b/README.md index 078949c3..7e82f561 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Cloud Shell Client for Java +# Google Cloud Shell Client for Java Java idiomatic client for [Cloud Shell][product-docs]. @@ -8,9 +8,6 @@ Java idiomatic client for [Cloud Shell][product-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 @@ -20,18 +17,19 @@ If you are using Maven, add this to your pom.xml file: com.google.cloud google-cloud-shell - 0.0.0 + 1.0.0 + ``` If you are using Gradle without BOM, add this to your dependencies ```Groovy -compile 'com.google.cloud:google-cloud-shell:0.0.0' +compile 'com.google.cloud:google-cloud-shell:1.0.0' ``` If you are using SBT, add this to your dependencies ```Scala -libraryDependencies += "com.google.cloud" % "google-cloud-shell" % "0.0.0" +libraryDependencies += "com.google.cloud" % "google-cloud-shell" % "1.0.0" ``` ## Authentication @@ -43,7 +41,7 @@ See the [Authentication][authentication] section in the base directory's README. ### Prerequisites You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Shell [API enabled][enable-api]. -You will need to [enable billing][enable-billing] to use Cloud Shell. +You will need to [enable billing][enable-billing] to use Google Cloud Shell. [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]`. @@ -56,13 +54,16 @@ to add `google-cloud-shell` as a dependency in your code. ## About Cloud Shell -[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. +[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. See the [Cloud Shell client library docs][javadocs] to learn how to use this Cloud Shell Client Library. + + + + + ## Troubleshooting 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 Cloud Shell uses gRPC for the transport layer. -## Java Versions +## Supported Java Versions Java 7 or above is required for using this client. +Google's Java client libraries, +[Google Cloud Client Libraries][cloudlibs] +and +[Google Cloud API Libraries][apilibs], +follow the +[Oracle Java SE support roadmap][oracle] +(see the Oracle Java SE Product Releases section). + +### For new development + +In general, new feature development occurs with support for the lowest Java +LTS version covered by Oracle's Premier Support (which typically lasts 5 years +from initial General Availability). If the minimum required JVM for a given +library is changed, it is accompanied by a [semver][semver] major release. + +Java 11 and (in September 2021) Java 17 are the best choices for new +development. + +### Keeping production systems current + +Google tests its client libraries with all current LTS versions covered by +Oracle's Extended Support (which typically lasts 8 years from initial +General Availability). + +#### Legacy support + +Google's client libraries support legacy versions of Java runtimes with long +term stable libraries that don't receive feature updates on a best efforts basis +as it may not be possible to backport all patches. + +Google provides updates on a best efforts basis to apps that continue to use +Java 7, though apps might need to upgrade to current versions of the library +that supports their JVM. + +#### Where to find specific information + +The latest versions and the supported Java versions are identified on +the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME` +and on [google-cloud-java][g-c-j]. + ## Versioning This library follows [Semantic Versioning](http://semver.org/). -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. - ## Contributing @@ -111,7 +149,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] Java is a registered trademark of Oracle and/or its affiliates. -[product-docs]: https://cloud.google.com/shell/docs/ +[product-docs]: https://cloud.google.com/shell/docs [javadocs]: https://googleapis.dev/java/google-cloud-shell/latest/index.html [kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java7.svg [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. [kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java8-win.html [kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java11.svg [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shell/java11.html -[stability-image]: https://img.shields.io/badge/stability-beta-yellow +[stability-image]: https://img.shields.io/badge/stability-ga-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-shell.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-shell&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication @@ -135,6 +173,12 @@ Java is a registered trademark of Oracle and/or its affiliates. [code-of-conduct]: https://github.com/googleapis/java-shell/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct [license]: https://github.com/googleapis/java-shell/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=shell.googleapis.com +[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudshell.googleapis.com [libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM -[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png \ No newline at end of file +[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png + +[semver]: https://semver.org/ +[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained +[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries +[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html +[g-c-j]: http://github.com/googleapis/google-cloud-java