Describe/update versioning

apache · Sep 6, 2022 · 303a26c · 303a26c
1 parent 324820d
commit 303a26c
Show file tree

Hide file tree

Showing 17 changed files with 40 additions and 25 deletions.
diff --git a/adbc.h b/adbc.h
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-/// \file ADBC: Arrow Database connectivity
+/// \file adbc.h ADBC: Arrow Database connectivity
 ///
 /// An Arrow-based interface between applications and database
 /// drivers.  ADBC aims to provide a vendor-independent API for SQL
@@ -28,7 +28,7 @@
 /// provided, which implements this same API, but dynamically loads
 /// drivers internally and forwards calls appropriately.
 ///
-/// EXPERIMENTAL. Interface subject to change.
+/// \version 1.0.0
 
 #pragma once
 
@@ -1190,6 +1190,8 @@ typedef AdbcStatusCode (*AdbcDriverInitFunc)(int version, void* driver,
 
 /// \page compatibility Backwards and Forwards Compatibility
 ///
+/// ## Compatibility
+///
 /// The goal is to be **ABI-compatible** across releases.  Hence, a
 /// few choices were made:
 ///
@@ -1221,6 +1223,23 @@ typedef AdbcStatusCode (*AdbcDriverInitFunc)(int version, void* driver,
 ///
 /// This approach does not let us change the signatures of existing
 /// functions, but we can add new functions and remove existing ones.
+///
+/// ## Versioning
+///
+/// ADBC is versioned separately from the core Arrow project.  The API
+/// standard and components (driver manager, drivers) are also
+/// versioned separately, but both follow semantic versioning.
+///
+/// For example: components may make backwards-compatible releases as
+/// 1.0.0, 1.0.1, 1.1.0, 1.2.0, etc.  They may release
+/// backwards-incompatible versions such as 2.0.0, but which still
+/// implement the API standard version 1.0.0.
+///
+/// Similarly, this documentation describes the ADBC API standard
+/// version 1.0.0.  If/when a compatible revision is made (e.g. new
+/// standard options are defined), the next version would be 1.1.0.
+/// If incompatible changes are made (e.g. new API functions), the
+/// next version would be 2.0.0.
 
 /// \page concurrency Concurrency and Thread Safety
 ///

diff --git a/c/cmake_modules/AdbcDefines.cmake b/c/cmake_modules/AdbcDefines.cmake
@@ -25,9 +25,9 @@ include(DefineOptions)
 include(GNUInstallDirs) # Populates CMAKE_INSTALL_INCLUDEDIR
 include(san-config)
 
-set(ADBC_VERSION "9.0.0-SNAPSHOT")
-set(ADBC_BASE_VERSION "9.0.0")
-set(ADBC_VERSION_MAJOR "9")
+set(ADBC_VERSION "1.0.0-SNAPSHOT")
+set(ADBC_BASE_VERSION "1.0.0")
+set(ADBC_VERSION_MAJOR "1")
 set(ADBC_VERSION_MINOR "0")
 set(ADBC_VERSION_PATCH "0")
 

diff --git a/java/core/pom.xml b/java/core/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>adbc-core</artifactId>

diff --git a/java/core/src/main/java/org/apache/arrow/adbc/core/package-info.java b/java/core/src/main/java/org/apache/arrow/adbc/core/package-info.java
@@ -27,6 +27,6 @@
  * provided, which implements this same API, but dynamically loads drivers internally and forwards
  * calls appropriately.
  *
- * <p>ADBC is currently experimental. Interface is subject to change.
+ * @version 1.0.0
  */
 package org.apache.arrow.adbc.core;
diff --git a/java/driver-manager/pom.xml b/java/driver-manager/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>adbc-driver-manager</artifactId>

diff --git a/java/driver/flight-sql-validation/pom.xml b/java/driver/flight-sql-validation/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/flight-sql/pom.xml b/java/driver/flight-sql/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/jdbc-util/pom.xml b/java/driver/jdbc-util/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/jdbc-validation-derby/pom.xml b/java/driver/jdbc-validation-derby/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/jdbc-validation-postgresql/pom.xml b/java/driver/jdbc-validation-postgresql/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/jdbc/pom.xml b/java/driver/jdbc/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/driver/validation/pom.xml b/java/driver/validation/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/java/pom.xml b/java/pom.xml
@@ -20,7 +20,7 @@
 
   <groupId>org.apache.arrow.adbc</groupId>
   <artifactId>arrow-adbc-java-root</artifactId>
-  <version>10.0.0-SNAPSHOT</version>
+  <version>1.0.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
   <name>Apache Arrow ADBC Java Root POM</name>
@@ -29,7 +29,7 @@
 
   <properties>
     <dep.arrow.version>9.0.0</dep.arrow.version>
-    <adbc.version>10.0.0-SNAPSHOT</adbc.version>
+    <adbc.version>1.0.0-SNAPSHOT</adbc.version>
   </properties>
 
   <scm>

diff --git a/java/sql/pom.xml b/java/sql/pom.xml
@@ -14,7 +14,7 @@
   <parent>
     <artifactId>arrow-adbc-java-root</artifactId>
     <groupId>org.apache.arrow.adbc</groupId>
-    <version>10.0.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>adbc-sql</artifactId>

diff --git a/java/sql/src/main/java/org/apache/arrow/adbc/sql/package-info.java b/java/sql/src/main/java/org/apache/arrow/adbc/sql/package-info.java
@@ -15,9 +15,5 @@
  * limitations under the License.
  */
 
-/**
- * This module contains common utilities for drivers working with SQL.
- *
- * <p>ADBC is currently experimental.
- */
+/** This module contains common utilities for drivers working with SQL. */
 package org.apache.arrow.adbc.sql;
diff --git a/python/adbc_driver_manager/pyproject.toml b/python/adbc_driver_manager/pyproject.toml
@@ -17,7 +17,7 @@
 
 [tool.poetry]
 name = "adbc_driver_manager"
-version = "0.0.1-alpha.1"
+version = "1.0.0-alpha.0"
 description = ""
 authors = ["Apache Arrow Developers <dev@arrow.apache.org>"]
 license = "Apache-2.0"

diff --git a/python/adbc_driver_postgres/pyproject.toml b/python/adbc_driver_postgres/pyproject.toml
@@ -17,7 +17,7 @@
 
 [tool.poetry]
 name = "adbc_driver_postgres"
-version = "0.0.0-alpha0"
+version = "1.0.0-alpha0"
 description = ""
 authors = ["Apache Arrow Developers <dev@arrow.apache.org>"]
 license = "Apache-2.0"