Merge pull request #306 from fd4s/binary-compatibility

Maintain binary compatibility across minor versions

Author: vlovgr

docs/src/main/mdoc/overview.md

@@ -5,7 +5,7 @@ title: Overview
 
 Functional backpressured streams for consuming and producing Kafka records. Exposes a small interface, while taking care of common functionality: batch consuming and producing records, batched offset commits, offset commit recovery, and topic administration, while also simplifying client configuration.
 
-Documentation is kept up-to-date with new releases, currently documenting v@LATEST_VERSION@ on Scala @DOCS_SCALA_MINOR_VERSION@.
+Documentation is kept up-to-date, currently documenting v@LATEST_VERSION@ on Scala @DOCS_SCALA_MINOR_VERSION@.
 
 ## Getting Started
 
@@ -39,8 +39,8 @@ Stable release artifacts are signed with the [`E97C 64AB 4987 7F74`](https://key
 
 ### Compatibility
 
-Backwards binary-compatibility for the library is guaranteed between patch versions.<br>
-For example, `@[email protected]` is backwards binary-compatible with `@[email protected]` for any `x > y`.
+Backwards binary-compatibility for the library is guaranteed between minor and patch versions.<br>
+Version `@[email protected]` is backwards binary-compatible with `@[email protected]` for any `a > c` or `a = c` and `b > d`.
 
 Please note binary-compatibility is not guaranteed between milestone releases.
 

docs/src/main/scala/fs2/kafka/docs/Main.scala

@@ -13,6 +13,11 @@ object Main {
     s"$major.$minor"
   }
 
+  def majorVersion(version: String): String = {
+    val Array(major, _, _) = version.split('.')
+    major
+  }
+
   def minorVersionsString(versions: Seq[String]): String = {
     val minorVersions = versions.map(minorVersion)
     if (minorVersions.size <= 2) minorVersions.mkString(" and ")
@@ -34,7 +39,7 @@ object Main {
           "VULCAN_CROSS_SCALA_VERSIONS" -> minorVersionsString(vulcanCrossScalaVersions),
           "LATEST_VERSION" -> latestVersion,
           "LATEST_SNAPSHOT_VERSION" -> latestSnapshotVersion,
-          "LATEST_MINOR_VERSION" -> minorVersion(latestVersion),
+          "LATEST_MAJOR_VERSION" -> majorVersion(latestVersion),
           "DOCS_SCALA_MINOR_VERSION" -> scalaMinorVersion,
           "FS2_VERSION" -> fs2Version,
           "KAFKA_VERSION" -> kafkaVersion,