Multi modules: separate Java library from native libs

.github/workflows/build-native.yml

@@ -86,9 +86,6 @@ jobs:
         with:
           repository: ${{ needs.check.outputs.repo }}
           ref: ${{ needs.check.outputs.ref }}
-      # Delete existing libs so we only upload the generated one into the artifact
-      - name: Delete existing native libs
-        run: rm -fr src/main/resources/org/sqlite/native
       - name: Build native libraries
         run: make ${{ matrix.target }}
         env:
@@ -97,7 +94,7 @@ jobs:
         uses: actions/upload-artifact@v7
         with:
           name: native-libs-${{ matrix.target }}
-          path: src/main/resources/org/sqlite/native/
+          path: target/store/
 
   push:
     name: Push new native libraries to branch
@@ -114,7 +111,6 @@ jobs:
         with:
           pattern: native-libs-*
           merge-multiple: true
-          path: src/main/resources/org/sqlite/native/
 
       - run: git status
       - name: Commit and push

.github/workflows/ci.yml

@@ -39,11 +39,11 @@ jobs:
       - uses: actions/setup-java@v5
         with:
           distribution: 'temurin'
-          java-version: 11
+          java-version: 17
           java-package: jdk
           cache: 'maven'
       - name: spotless:check
-        run: mvn --batch-mode --no-transfer-progress spotless:check
+        run: mvn -Pspotless --batch-mode --no-transfer-progress spotless:check
 
   test:
     name: test ${{ matrix.os }} jdk${{ matrix.java }}
@@ -208,7 +208,7 @@ jobs:
         uses: actions/setup-java@v5
         with: # running setup-java again overwrites the settings.xml
           distribution: 'temurin'
-          java-version: '11'
+          java-version: '17'
           java-package: jdk
           server-id: central # Value of the distributionManagement/repository/id field of the pom.xml
           server-username: MAVEN_CENTRAL_USERNAME # env variable for username in deploy (1)
@@ -231,7 +231,7 @@ jobs:
       - name: Build
         run: mvn --batch-mode --no-transfer-progress package -P release -DskipTests
 
-      # The sonatype maven plugin will decide the right destination depending on whether the project is SNAPSHOT or not
+      # The Sonatype maven plugin will decide the right destination depending on whether the project is SNAPSHOT or not
       - name: Publish to Apache Maven Central
         if: github.event_name == 'push' || inputs.push_maven
         run: mvn --batch-mode --no-transfer-progress deploy -P release -DskipTests -Dgpg.signer=bc
@@ -252,7 +252,7 @@ jobs:
         env:
           JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          mvn --batch-mode --no-transfer-progress -DskipTests jreleaser:full-release
+          mvn --non-recursive --batch-mode --no-transfer-progress -DskipTests jreleaser:full-release
       - name: Prepare next snapshot
         if: inputs.perform_release
         run: |

.github/workflows/set-version.yml

@@ -0,0 +1,38 @@
+name: Upgrade SQLite version
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_version:
+        description: 'New SQLite version (x.y.z)'
+        required: true
+        type: string
+
+jobs:
+  version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          java-package: jdk
+          cache: 'maven'
+
+      - name: Set SQLite version in VERSION
+        run: |
+          echo "version=${{ inputs.new_version }}" >> VERSION
+
+      - name: Update version in POM
+        run: |
+          mvn versions:set -DnewVersion=${{ inputs.new_version }}-SNAPSHOT -DgenerateBackupPoms=false
+
+      - run: git status
+
+#      - name: Commit and push
+#        uses: EndBug/add-and-commit@v9
+#        with:
+#          message: 'feat(sqlite): upgrade to sqlite ${{ inputs.new_version }}'
+#          default_author: github_actions

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Development
 ## Prerequisites
 
-- JDK 11
+- JDK 17
 
 ## Commits
 
@@ -20,7 +20,7 @@ Since August 2022 the commit messages follow the [Conventional Commits](https://
 # How to compile the native libraries
 ## Prerequisites
 
-1. JDK 11
+1. JDK 17
 2. Perl
 3. Maven
 4. make
@@ -30,8 +30,11 @@ Since August 2022 the commit messages follow the [Conventional Commits](https://
 8. Docker (for cross-compilation only)
 
 ## Version update
+Version update can be triggered through the **Upgrade SQLite version** workflow.
+
 1. Edit the `VERSION` file and set the SQLite version to use.
-2. Edit the version number in `pom.xml` to `${VERSION}.0-SNAPSHOT`. So if `VERSION`=`3.39.2`, the version number in `pom.xml` should be `3.39.2.0-SNAPSHOT`. 
+2. Use the Maven Versions plugin to update the version: `mvn versions:set -DnewVersion=${VERSION}.0-SNAPSHOT -DgenerateBackupPoms=false`. So if `VERSION`=`3.39.2`, the Maven version number should be `3.39.2.0-SNAPSHOT`. 
+
 
 ## Build for the current platform
 ```shell

Makefile

@@ -13,7 +13,7 @@ deploy:
 DOCKER_RUN_OPTS=--rm
 MVN:=mvn
 CODESIGN:=docker run $(DOCKER_RUN_OPTS) -v $$PWD:/workdir gotson/rcodesign sign
-SRC:=src/main/java
+SRC:=sqlite-jdbc-jni/src/main/java
 JAVA_CLASSPATH:=$(TARGET)/classpath/slf4j-api.jar
 SQLITE_OUT:=$(TARGET)/$(sqlite)-$(OS_NAME)-$(OS_ARCH)
 SQLITE_OBJ?=$(SQLITE_OUT)/sqlite3.o
@@ -76,15 +76,15 @@ $(JAVA_CLASSPATH):
 	@mkdir -p $(@D)
 	curl -L -f -o$@ https://search.maven.org/remotecontent?filepath=org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar
 
-$(TARGET)/common-lib/org/sqlite/%.class: src/main/java/org/sqlite/%.java
+$(TARGET)/common-lib/org/sqlite/%.class: sqlite-jdbc-jni/src/main/java/org/sqlite/%.java
 	@mkdir -p $(@D)
 	$(JAVAC) -source 1.6 -target 1.6 -sourcepath $(SRC) -d $(TARGET)/common-lib $<
 
 jni-header: $(TARGET)/common-lib/NativeDB.h
 
-$(TARGET)/common-lib/NativeDB.h: src/main/java/org/sqlite/core/NativeDB.java $(JAVA_CLASSPATH)
+$(TARGET)/common-lib/NativeDB.h: sqlite-jdbc-jni/src/main/java/org/sqlite/core/NativeDB.java $(JAVA_CLASSPATH)
 	@mkdir -p $(TARGET)/common-lib
-	$(JAVAC) -cp $(JAVA_CLASSPATH) -d $(TARGET)/common-lib -sourcepath $(SRC) -h $(TARGET)/common-lib src/main/java/org/sqlite/core/NativeDB.java
+	$(JAVAC) -cp $(JAVA_CLASSPATH) -d $(TARGET)/common-lib -sourcepath $(SRC) -h $(TARGET)/common-lib $(SRC)/org/sqlite/core/NativeDB.java
 	mv target/common-lib/org_sqlite_core_NativeDB.h target/common-lib/NativeDB.h
 
 test:
@@ -104,7 +104,7 @@ $(SQLITE_OUT)/sqlite3.o : $(SQLITE_UNPACKED)
 # limits defined here: https://www.sqlite.org/limits.html
 	perl -p -e "s/^(static const char \* const sqlite3azCompileOpt.+)$$/\1\n\n\/* This has been automatically added by sqlite-jdbc *\/\n  \"JDBC_EXTENSIONS\",/;" \
 	    $(SQLITE_OUT)/sqlite3.c.tmp > $(SQLITE_OUT)/sqlite3.c
-	cat src/main/ext/*.c >> $(SQLITE_OUT)/sqlite3.c
+	cat sqlite-jdbc-jni/src/main/ext/*.c >> $(SQLITE_OUT)/sqlite3.c
 	$(CC) -o $@ -c $(CCFLAGS) \
 	    -DSQLITE_ENABLE_LOAD_EXTENSION=1 \
 	    -DSQLITE_HAVE_ISNAN \
@@ -146,8 +146,13 @@ $(SQLITE_OUT)/$(LIBNAME): $(SQLITE_HEADER) $(SQLITE_OBJ) $(SRC)/org/sqlite/core/
 	$(STRIP) /tmp/$(@F)
 	cp /tmp/$(@F) $@
 
-NATIVE_DIR=src/main/resources/org/sqlite/native/$(OS_NAME)/$(OS_ARCH)
+# This is the java projects resources directories
+NATIVE_DIR=sqlite-jdbc-jni-libs/sqlite-jdbc-jni-libs-$(call lc,$(if $(OS_SHORTNAME),$(OS_SHORTNAME),$(OS_NAME)))-$(OS_ARCH)/src/main/resources/org/sqlite/native/$(OS_NAME)/$(OS_ARCH)
+# Not sure why we have this, leaving it for now
 NATIVE_TARGET_DIR:=$(TARGET)/classes/org/sqlite/native/$(OS_NAME)/$(OS_ARCH)
+# This is the exact hierarchy of updated native libraries
+# Will be used in Build Native CI workflow
+NATIVE_STORE_DIR:=$(TARGET)/store/$(NATIVE_DIR)
 NATIVE_DLL:=$(NATIVE_DIR)/$(LIBNAME)
 
 # For cross-compilation, install docker. See also https://github.com/dockcross/dockcross
@@ -160,6 +165,8 @@ $(NATIVE_DLL): $(SQLITE_OUT)/$(LIBNAME)
 	cp $< $@
 	@mkdir -p $(NATIVE_TARGET_DIR)
 	cp $< $(NATIVE_TARGET_DIR)/$(LIBNAME)
+	@mkdir -p $(NATIVE_STORE_DIR)
+	cp $< $(NATIVE_STORE_DIR)/$(LIBNAME)
 
 win32: $(SQLITE_UNPACKED) jni-header
 	./docker/dockcross-windows-x86 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=i686-w64-mingw32.static- OS_NAME=Windows OS_ARCH=x86'
@@ -189,13 +196,13 @@ freebsd-arm64: $(SQLITE_UNPACKED) jni-header
 	docker run $(DOCKER_RUN_OPTS) -v $$PWD:/workdir gotson/freebsd-cross-build:aarch64-11.4 sh -c 'make clean-native native OS_NAME=FreeBSD OS_ARCH=aarch64 CROSS_PREFIX=aarch64-unknown-freebsd11-'
 
 linux-musl32: $(SQLITE_UNPACKED) jni-header
-	docker run $(DOCKER_RUN_OPTS) -v $$PWD:/work gotson/alpine-linux-x86 bash -c 'make clean-native native OS_NAME=Linux-Musl OS_ARCH=x86'
+	docker run $(DOCKER_RUN_OPTS) -v $$PWD:/work gotson/alpine-linux-x86 bash -c 'make clean-native native OS_SHORTNAME=linux_musl OS_NAME=Linux-Musl OS_ARCH=x86'
 
 linux-musl64: $(SQLITE_UNPACKED) jni-header
-	docker run $(DOCKER_RUN_OPTS) -v $$PWD:/work xerial/alpine-linux-x86_64 bash -c 'make clean-native native OS_NAME=Linux-Musl OS_ARCH=x86_64'
+	docker run $(DOCKER_RUN_OPTS) -v $$PWD:/work xerial/alpine-linux-x86_64 bash -c 'make clean-native native OS_SHORTNAME=linux_musl OS_NAME=Linux-Musl OS_ARCH=x86_64'
 
 linux-musl-arm64: $(SQLITE_UNPACKED) jni-header
-	./docker/dockcross-musl-arm64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=aarch64-linux-musl- OS_NAME=Linux-Musl OS_ARCH=aarch64'
+	./docker/dockcross-musl-arm64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=aarch64-linux-musl- OS_SHORTNAME=linux_musl OS_NAME=Linux-Musl OS_ARCH=aarch64'
 
 linux-arm: $(SQLITE_UNPACKED) jni-header
 	./docker/dockcross-armv5 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=armv5-unknown-linux-gnueabi- OS_NAME=Linux OS_ARCH=arm'
@@ -210,16 +217,16 @@ linux-arm64: $(SQLITE_UNPACKED) jni-header
 	./docker/dockcross-arm64-lts -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=aarch64-unknown-linux-gnu- OS_NAME=Linux OS_ARCH=aarch64'
 
 linux-android-arm: $(SQLITE_UNPACKED) jni-header
-	./docker/dockcross-android-arm -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/arm-linux-androideabi/bin/arm-linux-androideabi- OS_NAME=Linux-Android OS_ARCH=arm'
+	./docker/dockcross-android-arm -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/arm-linux-androideabi/bin/arm-linux-androideabi- OS_SHORTNAME=android OS_NAME=Linux-Android OS_ARCH=arm'
 
 linux-android-arm64: $(SQLITE_UNPACKED) jni-header
-	./docker/dockcross-android-arm64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/aarch64-linux-android/bin/aarch64-linux-android- OS_NAME=Linux-Android OS_ARCH=aarch64'
+	./docker/dockcross-android-arm64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/aarch64-linux-android/bin/aarch64-linux-android- OS_SHORTNAME=android OS_NAME=Linux-Android OS_ARCH=aarch64'
 
 linux-android-x86: $(SQLITE_UNPACKED) jni-header
-	./docker/dockcross-android-x86 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/i686-linux-android/bin/i686-linux-android- OS_NAME=Linux-Android OS_ARCH=x86'
+	./docker/dockcross-android-x86 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/i686-linux-android/bin/i686-linux-android- OS_SHORTNAME=android OS_NAME=Linux-Android OS_ARCH=x86'
 
 linux-android-x64: $(SQLITE_UNPACKED) jni-header
-	./docker/dockcross-android-x86_64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/x86_64-linux-android/bin/x86_64-linux-android- OS_NAME=Linux-Android OS_ARCH=x86_64'
+	./docker/dockcross-android-x86_64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=/usr/x86_64-linux-android/bin/x86_64-linux-android- OS_SHORTNAME=android OS_NAME=Linux-Android OS_ARCH=x86_64'
 
 linux-ppc64: $(SQLITE_UNPACKED) jni-header
 	./docker/dockcross-ppc64 -a $(DOCKER_RUN_OPTS) bash -c 'make clean-native native CROSS_PREFIX=powerpc64le-unknown-linux-gnu- OS_NAME=Linux OS_ARCH=ppc64'
@@ -241,10 +248,12 @@ sparcv9:
 	$(MAKE) native OS_NAME=SunOS OS_ARCH=sparcv9
 
 mac64-signed: mac64
-	$(CODESIGN) src/main/resources/org/sqlite/native/Mac/x86_64/libsqlitejdbc.dylib
+	$(CODESIGN) target/store/sqlite-jdbc-jni-libs/sqlite-jdbc-jni-libs-mac-x86_64/src/main/resources/org/sqlite/native/Mac/x86_64/libsqlitejdbc.dylib
+	$(CODESIGN) sqlite-jdbc-jni-libs/sqlite-jdbc-jni-libs-mac-x86_64/src/main/resources/org/sqlite/native/Mac/x86_64/libsqlitejdbc.dylib
 
 mac-arm64-signed: mac-arm64
-	$(CODESIGN) src/main/resources/org/sqlite/native/Mac/aarch64/libsqlitejdbc.dylib
+	$(CODESIGN) target/store/sqlite-jdbc-jni-libs/sqlite-jdbc-jni-libs-mac-aarch64/src/main/resources/org/sqlite/native/Mac/aarch64/libsqlitejdbc.dylib
+	$(CODESIGN) sqlite-jdbc-jni-libs/sqlite-jdbc-jni-libs-mac-aarch64/src/main/resources/org/sqlite/native/Mac/aarch64/libsqlitejdbc.dylib
 
 package: native-all
 	rm -rf target/dependency-maven-plugin-markers

Makefile.common

@@ -9,17 +9,20 @@ JAVAC := "$$JAVA_HOME/bin/javac"
 JAVAH := "$$JAVA_HOME/bin/javah"
 
 TARGET := target
-SRC:=src/main/java
+SRC:=sqlite-jdbc-jni/src/main/java
 OSINFO_CLASS := org.sqlite.util.OSInfo
 OSINFO_PROG := lib/org/sqlite/util/OSInfo.class
 JAVA_CLASSPATH:=$(TARGET)/classpath/slf4j-api.jar
 
+# Lowercase function (pure Makefile, no shell)
+lc = $(shell echo $1 | tr '[:upper:]' '[:lower:]')
+
 ## building OSInfo.java
 ifeq ("$(wildcard $(OSINFO_PROG))","")
 $(info Building OSInfo tool)
 $(shell mkdir -p $(TARGET)/classpath)
 $(shell curl -L -f -o$(JAVA_CLASSPATH) https://search.maven.org/remotecontent?filepath=org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar)
-$(shell $(JAVAC) -cp $(JAVA_CLASSPATH) -sourcepath $(SRC) -d lib src/main/java/org/sqlite/util/OSInfo.java)
+$(shell $(JAVAC) -cp $(JAVA_CLASSPATH) -sourcepath $(SRC) -d lib $(SRC)/org/sqlite/util/OSInfo.java)
 endif
 
 ifndef OS_NAME

README.adoc

@@ -97,9 +97,8 @@ id = 2
 
 == How does SQLiteJDBC work?
 
-Our SQLite JDBC driver package (i.e., `sqlite-jdbc-{project-version}.jar`) contains three
-types of native SQLite libraries (`sqlitejdbc.dll`, `sqlitejdbc.dylib`, `sqlitejdbc.so`),
-each of them is compiled for Windows, macOS and Linux. An appropriate native library
+Our SQLite JDBC driver packages (i.e., `sqlite-jdbc-jni-libs-\{OS}-\{ARCH}-{project-version}.jar`) contain the native SQLite libraries (`sqlitejdbc.dll`, `sqlitejdbc.dylib`, `sqlitejdbc.so`)
+compiled for the specific `OS` and `ARCH`. An appropriate native library
 file is automatically extracted into your OS's temporary folder, when your program
 loads `org.sqlite.JDBC` driver.
 
@@ -169,6 +168,73 @@ When packaging the resulting app, simply include the library in the distribution
 
 Download from https://central.sonatype.com/artifact/org.xerial/sqlite-jdbc[Maven Central] or from the https://github.com/xerial/sqlite-jdbc/releases[releases] page.
 
+=== Modular packaging
+
+[source,xml,subs="attributes+"]
+----
+<dependencies>
+    <dependency>
+      <groupId>org.xerial</groupId>
+      <artifactId>sqlite-jdbc-jni</artifactId>
+      <version>{project-version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.xerial</groupId>
+      <artifactId>sqlite-jdbc-jni-libs-all</artifactId>
+      <version>{project-version}</version>
+    </dependency>
+</dependencies>
+----
+
+List of available native libraries artifacts:
+
+----
+sqlite-jdbc-jni-libs-all: All architectures for all OSes, except Android
+
+sqlite-jdbc-jni-libs-android: All architectures for Android
+sqlite-jdbc-jni-libs-android-aarch64
+sqlite-jdbc-jni-libs-android-arm
+sqlite-jdbc-jni-libs-android-x86
+sqlite-jdbc-jni-libs-android-x86_64
+
+sqlite-jdbc-jni-libs-freebsd: All architectures for FreeBSD
+sqlite-jdbc-jni-libs-freebsd-aarch64
+sqlite-jdbc-jni-libs-freebsd-x86
+sqlite-jdbc-jni-libs-freebsd-x86_64
+
+sqlite-jdbc-jni-libs-linux: All architectures for Linux
+sqlite-jdbc-jni-libs-linux-aarch64
+sqlite-jdbc-jni-libs-linux-arm
+sqlite-jdbc-jni-libs-linux-armv6
+sqlite-jdbc-jni-libs-linux-armv7
+sqlite-jdbc-jni-libs-linux-ppc64
+sqlite-jdbc-jni-libs-linux-riscv64
+sqlite-jdbc-jni-libs-linux-x86
+sqlite-jdbc-jni-libs-linux-x86_64
+
+sqlite-jdbc-jni-libs-linux_musl: All architectures for Linux Musl
+sqlite-jdbc-jni-libs-linux_musl-aarch64
+sqlite-jdbc-jni-libs-linux_musl-x86
+sqlite-jdbc-jni-libs-linux_musl-x86_64
+
+sqlite-jdbc-jni-libs-mac: All architectures for Mac
+sqlite-jdbc-jni-libs-mac-x86_64
+sqlite-jdbc-jni-libs-macos-aarch64
+
+sqlite-jdbc-jni-libs-windows: All architectures for Windows
+sqlite-jdbc-jni-libs-windows-aarch64
+sqlite-jdbc-jni-libs-windows-armv7
+sqlite-jdbc-jni-libs-windows-x86
+sqlite-jdbc-jni-libs-windows-x86_64
+----
+
+=== Legacy packaging
+
+The historical `artifactId` will pull:
+
+- `sqlite-jdbc-jni`
+- `sqlite-jdbc-jni-libs-all`
+
 [source,xml,subs="attributes+"]
 ----
 <dependencies>

jreleaser.yml

@@ -1,4 +1,5 @@
 project:
+  name: sqlite-jdbc
   versionPattern: CUSTOM
   copyright: Taro L. Saito
 release:
@@ -44,5 +45,5 @@ release:
         description: 'Issue has been released'
         color: '#ededed'
 files:
-  artifacts:
-    - path: 'target/{{projectName}}-{{projectVersion}}.jar'
+  globs:
+    - pattern: '**/target/sqlite-jdbc-jni*-{{projectVersion}}.jar'