Merge pull request #564 from brendandburns/readme

Improve documentation of potential breaking changes. Add changelog for 4.0.0

Author: k8s-ci-robot

CHANGELOG.md

@@ -1,3 +1,19 @@
+# 4.0.0-alpha1
+Changes since 3.0.0
+Changes since 4.0.0-beta1
+* Fix DateTime string generation. (#500)
+* Update proto buff files for 1.13.0 (#498)
+* Improve auth tests, fix a bug in credential parsing (#465)
+* NPE System.getenv(ENV_HOME) returns null on Windows (#455)
+* Fix serialization of null quantities  (#442)
+* Fix Quantity serialization
+* Add merge in ProtoClient
+* Invoke async callback on unexpected exceptions
+* Update to 1.12 generated code. Fix a few compile errors w/ the new code.
+
+*Note*
+This library includes an update to the generated Kubernetes code which may contain breaking API changes.
+
 # 3.0.0
 Changes Since 2.0.0
 
@@ -17,6 +33,9 @@ Changes Since 2.0.0
 * Support refresh for Azure Active Directory tokens.
 * Regenerate client for Kubernetes 1.11
 
+*Note*
+This library includes an update to the generated Kubernetes code which may contain breaking API changes.
+
 # 2.0.0
 
 Changes since 1.0.0:
@@ -29,6 +48,9 @@ Changes since 1.0.0:
 * Add a warning and an exception if a watch is created with debugging enabled. #280
 * Update to 1.10 API.
 
+*Note*
+This library includes an update to the generated Kubernetes code which may contain breaking API changes.
+
 # 1.0.0
 * Fix a bug with HTML escaping byte arrays (#240)
 * Fix a bug with YAML parsing IntOrString types (#242)

README.md

@@ -6,6 +6,12 @@
 
 Java client for the [kubernetes](http://kubernetes.io/) API.
 
+## Client versioning
+The Java client uses Semantic Versioning. We increment the major version number whenever we
+regenerate the client for a new Kubernetes release version (see table below). Whenever we do
+this there are new APIs added and possibly breaking changes in the generated Kubernetes API
+Stubs. Whenever you upgrade a major version, be prepared for potential breaking changes.
+
 ## Installation
 
 To install the Java client library to your local Maven repository, simply execute: