feat: Prepare for the first release on maven central.

Still need to set up publishing, but the project is in a good point right now.

Author: ryanhallock

.github/workflows/build.yml

@@ -0,0 +1,32 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up JDK 25
+        uses: actions/setup-java@v5
+        with:
+          java-version: '25'
+          distribution: 'graalvm'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
+        with:
+          cache-read-only: ${{ github.event_name != 'push' }}
+      - name: Build with Gradle
+        run: ./gradlew build
+      - name: Javadoc with Gradle
+        run: ./gradlew javadoc
+      - name: Test with Gradle
+        run: ./gradlew test
+      - name: Native tests with Gradle
+        run: ./gradlew nativeTest

README.md

@@ -1,6 +1,14 @@
 # zstd-java
 
-Java bindings for the Zstandard compression library. Its meant to replace the use of JNI with FFM.
+Java bindings for the Zstandard compression library.
+
+### Provides
+- `dev.hallock.zstd` is higher level bindings (Module)
+- `dev.hallock.zstd.bindings` the underlying native bindings (Module)
+
+### Dependencies
+- Java 25 or higher
+- Zstandard library (zstd)
 
 ### Usage
 Adding to Gradle (kts):
@@ -10,12 +18,16 @@ repositories {
 }
 
 dependencies {
-    implementation("dev.hallock.zstd:zstd:0.1.0")
+    implementation("dev.hallock.zstd:zstd:<version>")
 }
 ```
+where `<version>` is the latest tag.
+
+### Runtime
+Ideally you want your project to be using JPMS as running on the module path allows nicer syntax to open native access. 
+`--enable-native-access=dev.hallock.zstd.bindings` should be used to allow native access to the native Zstandard library.
 
-### Java
-Requires Java 25 and will target LTS releases.
+Running in the unnamed module should be supported but is not recommended.
 
 #### Resources
 - [Zstandard](https://facebook.github.io/zstd/doc/api_manual_latest.html)
@@ -24,8 +36,8 @@ Requires Java 25 and will target LTS releases.
 
 <details>
 <summary>AI Disclosure</summary>
-AI was used to generate the Demo example, and most of the tests. My philosophy is that AI generated tests are slightly better coverage than no coverage. 
-This may change in the future and is the only place(s) that is acceptable usage.
+AI was used to generate most of the tests. My philosophy is that AI generated tests are slightly better coverage than no coverage. 
+This should change in the future and is the only place that is acceptable usage.
 </details>
 
 

ROADMAP.md

@@ -0,0 +1,18 @@
+### Roadmap
+Javadocs and better fail fast checking
+
+Create bundled bindings for popular platforms (Windows, Linux, MacOS) to avoid the need for users to install the Zstandard library separately.
+
+Create validation abstraction for streaming (Currently streaming works but allows out of bound accesses)
+
+Support byte[] and ByteBuffer APIs for easier integration with existing code, (Likely copying data to native memory)
+
+Validate native-image reachability metadata on push and create a workflow for it.
+
+Validate jextract on push and create a workflow for it.
+
+Support bindings separately to allow implementations that just consume the jextract module. (native image reachability)
+
+1.0 Will not be tagged until all TODOS are addressed, and Streaming no longer can do out of bound accesses
+
+Consider splitting API into dev.hallock.zstd.api to use services pro

bindings/build.gradle.kts

@@ -1,10 +1,10 @@
 plugins {
-    id("java-library")
-    id("de.infolektuell.jextract") version "1.3.0"
+    `java-library`
+    alias(libs.plugins.jextract)
 }
 
 group = "dev.hallock.zstd"
-version = "0.1-SNAPSHOT"
+version = findProperty("version") ?: "dev"
 
 repositories {
     mavenCentral()
@@ -16,7 +16,7 @@ java {
 }
 
 dependencies {
-    api("org.jspecify:jspecify:1.0.0")
+    api(libs.jspecify)
 }
 
 jextract.libraries {

build.gradle.kts

@@ -1,34 +1,38 @@
 plugins {
-    id("java-library")
-    id("org.graalvm.buildtools.native") version "0.11.2"
+    `java-library`
+    alias(libs.plugins.graalvm.buildtools)
 }
 
 group = "dev.hallock.zstd"
-version = "0.1-SNAPSHOT"
+version = findProperty("version") ?: "dev"
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    api("org.jspecify:jspecify:1.0.0")
+    api(libs.jspecify)
     api(project(":bindings"))
-    testImplementation(platform("org.junit:junit-bom:6.0.0"))
-    testImplementation("org.junit.jupiter:junit-jupiter")
-    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+    testImplementation(platform(libs.junit.bom))
+    testImplementation(libs.junit.jupiter)
+    testRuntimeOnly(libs.junit.platform.launcher)
 }
 
 tasks.test {
     useJUnitPlatform()
-    jvmArgs("--enable-native-access=dev.hallock.zstd.bindings");
+    jvmArgs("--enable-native-access=dev.hallock.zstd.bindings")
 }
 
-
 java {
     toolchain.languageVersion = JavaLanguageVersion.of(25)
     modularity.inferModulePath = true
 }
 
+tasks.compileJava {
+    options.compilerArgs.add("-Xlint:all")
+    options.compilerArgs.add("-Werror")
+    options.encoding = "UTF-8"
+}
 
 graalvmNative {
     agent {
@@ -50,7 +54,7 @@ graalvmNative {
         binaries {
             named("test") {
                 buildArgs.add("-O0")
-                jvmArgs.add("--enable-native-access=dev.hallock.zstd.bindings")
+                jvmArgs.add("--enable-native-access=ALL-UNNAMED") //TODO figure out why this isn't using modules
             }
         }
     }