Skip to content

Commit 959d4f8

Browse files
authored
chore(docs): update README.md to add java support policy (#1152)
Add policy from https://cloud.google.com/java/docs/supported-java-versions
1 parent 1620b2c commit 959d4f8

File tree

1 file changed

+47
-1
lines changed
  • synthtool/gcp/templates/java_library

1 file changed

+47
-1
lines changed

synthtool/gcp/templates/java_library/README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,50 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
121121
{% endif %}
122122
{% endif -%}
123123

124-
## Java Versions
124+
## Supported Java Versions
125125

126126
Java {{ metadata['min_java_version'] }} or above is required for using this client.
127127

128+
Google's Java client libraries,
129+
[Google Cloud Client Libraries][cloudlibs]
130+
and
131+
[Google Cloud API Libraries][apilibs],
132+
follow the
133+
[Oracle Java SE support roadmap][oracle]
134+
(see the Oracle Java SE Product Releases section).
135+
136+
### For new development
137+
138+
In general, new feature development occurs with support for the lowest Java
139+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
140+
from initial General Availability). If the minimum required JVM for a given
141+
library is changed, it is accompanied by a [semver][semver] major release.
142+
143+
Java 11 and (in September 2021) Java 17 are the best choices for new
144+
development.
145+
146+
### Keeping production systems current
147+
148+
Google tests its client libraries with all current LTS versions covered by
149+
Oracle's Extended Support (which typically lasts 8 years from initial
150+
General Availability).
151+
152+
#### Legacy support
153+
154+
Google's client libraries support legacy versions of Java runtimes with long
155+
term stable libraries that don't receive feature updates on a best efforts basis
156+
as it may not be possible to backport all patches.
157+
158+
Google provides updates on a best efforts basis to apps that continue to use
159+
Java 7, though apps might need to upgrade to current versions of the library
160+
that supports their JVM.
161+
162+
#### Where to find specific information
163+
164+
The latest versions and the supported Java versions are identified on
165+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
166+
and on [google-cloud-java][g-c-j].
167+
128168
## Versioning
129169

130170
{% if 'partials' in metadata and metadata['partials']['versioning'] -%}
@@ -192,3 +232,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
192232
{% if metadata['repo']['api_id'] %}[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid={{ metadata['repo']['api_id'] }}{% endif %}
193233
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
194234
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
235+
236+
[semver]: https://semver.org/
237+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
238+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
239+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
240+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)