From 9190e37ee2e96dfdd20457250835d62a9dd2bd46 Mon Sep 17 00:00:00 2001 From: Hanzhen Yi <33737743+hzyi-google@users.noreply.github.com> Date: Fri, 10 Aug 2018 16:00:31 -0700 Subject: [PATCH 1/4] Move BOM info to right after Quick Start --- README.md | 114 +++++++++++++++++++++++++++--------------------------- 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index bba10b9e3640..5e437515c69f 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,63 @@ These client libraries can be used on App Engine standard for Java 8 runtime and If you are running into problems with version conflicts, see [Version Management](#version-management). +Version Management +------------------ + +The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: + +[//]: # ({x-version-update-start:google-cloud-bom:released}) +```xml + + + + com.google.cloud + google-cloud-bom + 0.57.0-alpha + pom + import + + + +``` +[//]: # ({x-version-update-end}) + +This BOM is only available starting at version 0.32.0-alpha. If you are having problems with prior versions of +google-cloud, use the following table as a reference to make sure that your versions are compatible. Definitions: + +* **alpha**: The version of any alpha package in google-cloud +* **beta**: The version of any beta package in google-cloud +* **GA**: The version of any GA package in google-cloud +* **gax**: The version of com.google.api:gax +* **gax-grpc**: The version of com.google.api:gax-grpc + +Something to be aware of is that a package can be promoted from alpha -> beta or beta -> GA between versions, which +means that after a certain point for any given package, the alpha or beta version won't be valid any more. + +alpha | beta | GA | gax | gax-grpc +------------- | ------------ | ---------- | ---------- | -------- +0.30.0-alpha | 0.30.0-beta | 1.12.0 | 1.15.0 | 1.15.0 +0.29.0-alpha | 0.29.0-beta | 1.11.0 | 1.15.0 | 1.15.0 +0.28.0-alpha | 0.28.0-beta | 1.10.0 | 1.14.0 | 1.14.0 +0.27.0-alpha | 0.27.0-beta | 1.9.0 | 1.13.0 | 0.30.0 +0.26.0-alpha | 0.26.0-beta | 1.8.0 | 1.9.0 | 0.26.0 +0.25.0-alpha | 0.25.0-beta | 1.7.0 | 1.8.1 | 0.25.1 +0.24.0-alpha | 0.24.0-beta | 1.6.0 | 1.8.1 | 0.25.1 +0.23.1-alpha | 0.23.1-beta | 1.5.1 | 1.8.1 | 0.25.1 +0.23.0-alpha | 0.23.0-beta | 1.5.0 | 1.5.0 | 0.22.0 +0.22.0-alpha | 0.22.0-beta | 1.4.0 | 1.5.0 | 0.22.0 +0.21.1-alpha | 0.21.1-beta | 1.3.1 | 1.5.0 | 0.22.0 +0.21.0-alpha | 0.21.0-beta | 1.3.0 | 1.5.0 | 0.22.0 +0.20.3-alpha | 0.20.3-beta | 1.2.3 | 1.4.2 | 0.21.2 +0.20.2-alpha | 0.20.2-beta | 1.2.2 | 1.4.2 | 0.21.2 +0.20.1-alpha | 0.20.1-beta | 1.2.1 | 1.4.1 | 0.21.1 +0.20.0-alpha | 0.20.0-beta | 1.2.0 | 1.3.1 | 0.20.0 +0.19.0-alpha | 0.19.0-beta | 1.1.0 | 1.3.0 | 0.19.0 +0.18.0-alpha | 0.18.0-beta | 1.0.2 | 1.1.0 | 0.17.0 +0.17.2-alpha | 0.17.2-beta | 1.0.1 | 1.0.0 | 0.16.0 +0.17.1-alpha | 0.17.1-beta | 1.0.0 | 1.0.0 | 0.16.0 +0.17.0-alpha | 0.17.0-beta | 1.0.0-rc4 | 1.0.0-rc1 | 0.15.0 + Specifying a Project ID ----------------------- @@ -280,63 +337,6 @@ a higher priority. are more likely to get backwards-incompatible updates. Additionally, it's possible for Alpha libraries to get deprecated and deleted before ever being promoted to Beta or GA. -Version Management ------------------- - -The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: - -[//]: # ({x-version-update-start:google-cloud-bom:released}) -```xml - - - - com.google.cloud - google-cloud-bom - 0.57.0-alpha - pom - import - - - -``` -[//]: # ({x-version-update-end}) - -This BOM is only available starting at version 0.32.0-alpha. If you are having problems with prior versions of -google-cloud, use the following table as a reference to make sure that your versions are compatible. Definitions: - -* **alpha**: The version of any alpha package in google-cloud -* **beta**: The version of any beta package in google-cloud -* **GA**: The version of any GA package in google-cloud -* **gax**: The version of com.google.api:gax -* **gax-grpc**: The version of com.google.api:gax-grpc - -Something to be aware of is that a package can be promoted from alpha -> beta or beta -> GA between versions, which -means that after a certain point for any given package, the alpha or beta version won't be valid any more. - -alpha | beta | GA | gax | gax-grpc -------------- | ------------ | ---------- | ---------- | -------- -0.30.0-alpha | 0.30.0-beta | 1.12.0 | 1.15.0 | 1.15.0 -0.29.0-alpha | 0.29.0-beta | 1.11.0 | 1.15.0 | 1.15.0 -0.28.0-alpha | 0.28.0-beta | 1.10.0 | 1.14.0 | 1.14.0 -0.27.0-alpha | 0.27.0-beta | 1.9.0 | 1.13.0 | 0.30.0 -0.26.0-alpha | 0.26.0-beta | 1.8.0 | 1.9.0 | 0.26.0 -0.25.0-alpha | 0.25.0-beta | 1.7.0 | 1.8.1 | 0.25.1 -0.24.0-alpha | 0.24.0-beta | 1.6.0 | 1.8.1 | 0.25.1 -0.23.1-alpha | 0.23.1-beta | 1.5.1 | 1.8.1 | 0.25.1 -0.23.0-alpha | 0.23.0-beta | 1.5.0 | 1.5.0 | 0.22.0 -0.22.0-alpha | 0.22.0-beta | 1.4.0 | 1.5.0 | 0.22.0 -0.21.1-alpha | 0.21.1-beta | 1.3.1 | 1.5.0 | 0.22.0 -0.21.0-alpha | 0.21.0-beta | 1.3.0 | 1.5.0 | 0.22.0 -0.20.3-alpha | 0.20.3-beta | 1.2.3 | 1.4.2 | 0.21.2 -0.20.2-alpha | 0.20.2-beta | 1.2.2 | 1.4.2 | 0.21.2 -0.20.1-alpha | 0.20.1-beta | 1.2.1 | 1.4.1 | 0.21.1 -0.20.0-alpha | 0.20.0-beta | 1.2.0 | 1.3.1 | 0.20.0 -0.19.0-alpha | 0.19.0-beta | 1.1.0 | 1.3.0 | 0.19.0 -0.18.0-alpha | 0.18.0-beta | 1.0.2 | 1.1.0 | 0.17.0 -0.17.2-alpha | 0.17.2-beta | 1.0.1 | 1.0.0 | 0.16.0 -0.17.1-alpha | 0.17.1-beta | 1.0.0 | 1.0.0 | 0.16.0 -0.17.0-alpha | 0.17.0-beta | 1.0.0-rc4 | 1.0.0-rc1 | 0.15.0 - Contributing ------------ From e2846aab1610639e942c55696878c9371ec5fa2f Mon Sep 17 00:00:00 2001 From: Hanzhen Yi Date: Mon, 20 Aug 2018 11:28:00 -0700 Subject: [PATCH 2/4] split version management --- README.md | 100 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 59 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 5e437515c69f..380d8173d5dc 100644 --- a/README.md +++ b/README.md @@ -84,12 +84,7 @@ Besides adding client libraries, the plugins provide additional functionality, s These client libraries can be used on App Engine standard for Java 8 runtime and App Engine flexible (including the Compat runtime). Most of the libraries do not work on the App Engine standard for Java 7 runtime. However, Datastore, Storage, and Bigquery should work. -If you are running into problems with version conflicts, see [Version Management](#version-management). - -Version Management ------------------- - -The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: +If you are running into problems with version conflicts, the easiest way to solve the conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: [//]: # ({x-version-update-start:google-cloud-bom:released}) ```xml @@ -107,41 +102,7 @@ The easiest way to solve version conflicts is to use google-cloud's BOM. In Mave ``` [//]: # ({x-version-update-end}) -This BOM is only available starting at version 0.32.0-alpha. If you are having problems with prior versions of -google-cloud, use the following table as a reference to make sure that your versions are compatible. Definitions: - -* **alpha**: The version of any alpha package in google-cloud -* **beta**: The version of any beta package in google-cloud -* **GA**: The version of any GA package in google-cloud -* **gax**: The version of com.google.api:gax -* **gax-grpc**: The version of com.google.api:gax-grpc - -Something to be aware of is that a package can be promoted from alpha -> beta or beta -> GA between versions, which -means that after a certain point for any given package, the alpha or beta version won't be valid any more. - -alpha | beta | GA | gax | gax-grpc -------------- | ------------ | ---------- | ---------- | -------- -0.30.0-alpha | 0.30.0-beta | 1.12.0 | 1.15.0 | 1.15.0 -0.29.0-alpha | 0.29.0-beta | 1.11.0 | 1.15.0 | 1.15.0 -0.28.0-alpha | 0.28.0-beta | 1.10.0 | 1.14.0 | 1.14.0 -0.27.0-alpha | 0.27.0-beta | 1.9.0 | 1.13.0 | 0.30.0 -0.26.0-alpha | 0.26.0-beta | 1.8.0 | 1.9.0 | 0.26.0 -0.25.0-alpha | 0.25.0-beta | 1.7.0 | 1.8.1 | 0.25.1 -0.24.0-alpha | 0.24.0-beta | 1.6.0 | 1.8.1 | 0.25.1 -0.23.1-alpha | 0.23.1-beta | 1.5.1 | 1.8.1 | 0.25.1 -0.23.0-alpha | 0.23.0-beta | 1.5.0 | 1.5.0 | 0.22.0 -0.22.0-alpha | 0.22.0-beta | 1.4.0 | 1.5.0 | 0.22.0 -0.21.1-alpha | 0.21.1-beta | 1.3.1 | 1.5.0 | 0.22.0 -0.21.0-alpha | 0.21.0-beta | 1.3.0 | 1.5.0 | 0.22.0 -0.20.3-alpha | 0.20.3-beta | 1.2.3 | 1.4.2 | 0.21.2 -0.20.2-alpha | 0.20.2-beta | 1.2.2 | 1.4.2 | 0.21.2 -0.20.1-alpha | 0.20.1-beta | 1.2.1 | 1.4.1 | 0.21.1 -0.20.0-alpha | 0.20.0-beta | 1.2.0 | 1.3.1 | 0.20.0 -0.19.0-alpha | 0.19.0-beta | 1.1.0 | 1.3.0 | 0.19.0 -0.18.0-alpha | 0.18.0-beta | 1.0.2 | 1.1.0 | 0.17.0 -0.17.2-alpha | 0.17.2-beta | 1.0.1 | 1.0.0 | 0.16.0 -0.17.1-alpha | 0.17.1-beta | 1.0.0 | 1.0.0 | 0.16.0 -0.17.0-alpha | 0.17.0-beta | 1.0.0-rc4 | 1.0.0-rc1 | 0.15.0 +For more details about how to use BOM, see [Version Management](#version-management). Specifying a Project ID ----------------------- @@ -337,6 +298,63 @@ a higher priority. are more likely to get backwards-incompatible updates. Additionally, it's possible for Alpha libraries to get deprecated and deleted before ever being promoted to Beta or GA. +Version Management +------------------ + +The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: + +[//]: # ({x-version-update-start:google-cloud-bom:released}) +```xml + + + + com.google.cloud + google-cloud-bom + 0.57.0-alpha + pom + import + + + +``` +[//]: # ({x-version-update-end}) + +This BOM is only available starting at version 0.32.0-alpha. If you are having problems with prior versions of +google-cloud, use the following table as a reference to make sure that your versions are compatible. Definitions: + +* **alpha**: The version of any alpha package in google-cloud +* **beta**: The version of any beta package in google-cloud +* **GA**: The version of any GA package in google-cloud +* **gax**: The version of com.google.api:gax +* **gax-grpc**: The version of com.google.api:gax-grpc + +Something to be aware of is that a package can be promoted from alpha -> beta or beta -> GA between versions, which +means that after a certain point for any given package, the alpha or beta version won't be valid any more. + +alpha | beta | GA | gax | gax-grpc +------------- | ------------ | ---------- | ---------- | -------- +0.30.0-alpha | 0.30.0-beta | 1.12.0 | 1.15.0 | 1.15.0 +0.29.0-alpha | 0.29.0-beta | 1.11.0 | 1.15.0 | 1.15.0 +0.28.0-alpha | 0.28.0-beta | 1.10.0 | 1.14.0 | 1.14.0 +0.27.0-alpha | 0.27.0-beta | 1.9.0 | 1.13.0 | 0.30.0 +0.26.0-alpha | 0.26.0-beta | 1.8.0 | 1.9.0 | 0.26.0 +0.25.0-alpha | 0.25.0-beta | 1.7.0 | 1.8.1 | 0.25.1 +0.24.0-alpha | 0.24.0-beta | 1.6.0 | 1.8.1 | 0.25.1 +0.23.1-alpha | 0.23.1-beta | 1.5.1 | 1.8.1 | 0.25.1 +0.23.0-alpha | 0.23.0-beta | 1.5.0 | 1.5.0 | 0.22.0 +0.22.0-alpha | 0.22.0-beta | 1.4.0 | 1.5.0 | 0.22.0 +0.21.1-alpha | 0.21.1-beta | 1.3.1 | 1.5.0 | 0.22.0 +0.21.0-alpha | 0.21.0-beta | 1.3.0 | 1.5.0 | 0.22.0 +0.20.3-alpha | 0.20.3-beta | 1.2.3 | 1.4.2 | 0.21.2 +0.20.2-alpha | 0.20.2-beta | 1.2.2 | 1.4.2 | 0.21.2 +0.20.1-alpha | 0.20.1-beta | 1.2.1 | 1.4.1 | 0.21.1 +0.20.0-alpha | 0.20.0-beta | 1.2.0 | 1.3.1 | 0.20.0 +0.19.0-alpha | 0.19.0-beta | 1.1.0 | 1.3.0 | 0.19.0 +0.18.0-alpha | 0.18.0-beta | 1.0.2 | 1.1.0 | 0.17.0 +0.17.2-alpha | 0.17.2-beta | 1.0.1 | 1.0.0 | 0.16.0 +0.17.1-alpha | 0.17.1-beta | 1.0.0 | 1.0.0 | 0.16.0 +0.17.0-alpha | 0.17.0-beta | 1.0.0-rc4 | 1.0.0-rc1 | 0.15.0 + Contributing ------------ From 61ebc91411a699ebda1a0eb7cdd8e912f7a1333c Mon Sep 17 00:00:00 2001 From: Hanzhen Yi <33737743+hzyi-google@users.noreply.github.com> Date: Fri, 24 Aug 2018 09:32:08 -0700 Subject: [PATCH 3/4] change to old version combinations --- README.md | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 380d8173d5dc..14dcb344abfd 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ If you are running into problems with version conflicts, the easiest way to solv ``` [//]: # ({x-version-update-end}) -For more details about how to use BOM, see [Version Management](#version-management). +Note that the BOM is only available starting at version 0.32.0-alpha. For prior versions, refer to [Old Version Combinations](#old-version-combinations) to make sure that your versions are compatible. Specifying a Project ID ----------------------- @@ -298,29 +298,10 @@ a higher priority. are more likely to get backwards-incompatible updates. Additionally, it's possible for Alpha libraries to get deprecated and deleted before ever being promoted to Beta or GA. -Version Management +Old Version Combinations ------------------ -The easiest way to solve version conflicts is to use google-cloud's BOM. In Maven, add the following to your POM: - -[//]: # ({x-version-update-start:google-cloud-bom:released}) -```xml - - - - com.google.cloud - google-cloud-bom - 0.57.0-alpha - pom - import - - - -``` -[//]: # ({x-version-update-end}) - -This BOM is only available starting at version 0.32.0-alpha. If you are having problems with prior versions of -google-cloud, use the following table as a reference to make sure that your versions are compatible. Definitions: +If you are having problems with google-cloud prior to version 0.32.0-alpha, use the following table as a reference to make sure that your versions are compatible. Definitions: * **alpha**: The version of any alpha package in google-cloud * **beta**: The version of any beta package in google-cloud From b1e061708bfcbc15a325f4e10f8196a5ec9f13e6 Mon Sep 17 00:00:00 2001 From: Hanzhen Yi <33737743+hzyi-google@users.noreply.github.com> Date: Fri, 24 Aug 2018 09:34:22 -0700 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14dcb344abfd..ad91e284bfa8 100644 --- a/README.md +++ b/README.md @@ -301,7 +301,7 @@ libraries to get deprecated and deleted before ever being promoted to Beta or GA Old Version Combinations ------------------ -If you are having problems with google-cloud prior to version 0.32.0-alpha, use the following table as a reference to make sure that your versions are compatible. Definitions: +If you are having compatbility problems with google-cloud prior to version 0.32.0-alpha, use the following table as a reference to make sure that your versions are compatible. Definitions: * **alpha**: The version of any alpha package in google-cloud * **beta**: The version of any beta package in google-cloud