Skip to content

Add maven examples for Java API #3783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csukuangfj merged 5 commits into from
Jul 22, 2026
Merged

Add maven examples for Java API #3783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d526e4a
Publish jar files to jitpack
csukuangfj Jul 22, 2026
f8a0b47
change group id
csukuangfj Jul 22, 2026
74944b8
Fix typos
csukuangfj Jul 22, 2026
2fc8f62
Add maven examples for Java API
csukuangfj Jul 22, 2026
c4da2fb
Remove unused files
csukuangfj Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 38 additions & 7 deletions .github/workflows/jar.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: jar
on:
push:
branches:
- refactor-jar
- refactor-jar-2
tags:
- 'v[0-9]+.[0-9]+.[0-9]+*'

Expand Down Expand Up @@ -156,7 +156,7 @@ jobs:
- name: Create java jar (native lib)
shell: bash
run: |
SHERPA_ONNX_VERSION=v$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)

cd sherpa-onnx/java-api

Expand Down Expand Up @@ -190,41 +190,72 @@ jobs:
- name: Show java jar (source code)
shell: bash
run: |
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)

cd sherpa-onnx/java-api

unzip -l build/sherpa-onnx.jar

cp -v build/sherpa-onnx.jar ./sherpa-onnx-jvm-$SHERPA_ONNX_VERSION.jar

ls -lh *.jar

unzip -l ./sherpa-onnx-jvm-$SHERPA_ONNX_VERSION.jar

- name: Show java jar (native lib)
shell: bash
run: |
cd sherpa-onnx/java-api

unzip -l sherpa-onnx*.jar
ls -lh *.jar

unzip -l sherpa-onnx-jvm*.jar
echo "---"
unzip -l sherpa-onnx-native*.jar

- name: Release jar
if: github.repository_owner == 'k2-fsa' && github.event_name == 'push' && contains(github.ref, 'refs/tags/')
uses: svenstaro/upload-release-action@v2
with:
file_glob: true
overwrite: true
file: ./sherpa-onnx/java-api/sherpa-onnx-native-*.jar
file: ./sherpa-onnx/java-api/sherpa-onnx-native*.jar

- name: Release jar
if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/')
uses: svenstaro/upload-release-action@v2
with:
file_glob: true
overwrite: true
file: ./sherpa-onnx/java-api/sherpa-onnx-native-*.jar
file: ./sherpa-onnx/java-api/sherpa-onnx-native*.jar
repo_name: k2-fsa/sherpa-onnx
repo_token: ${{ secrets.UPLOAD_GH_SHERPA_ONNX_TOKEN }}
tag: v1.13.4

- name: Release jar
if: github.repository_owner == 'k2-fsa' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.os == 'ubuntu-24.04-arm'
uses: svenstaro/upload-release-action@v2
with:
file_glob: true
overwrite: true
file: ./sherpa-onnx/java-api/sherpa-onnx-jvm*.jar

- name: Release jar
if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.os == 'ubuntu-24.04-arm'
uses: svenstaro/upload-release-action@v2
with:
file_glob: true
overwrite: true
file: ./sherpa-onnx/java-api/sherpa-onnx-jvm*.jar
repo_name: k2-fsa/sherpa-onnx
repo_token: ${{ secrets.UPLOAD_GH_SHERPA_ONNX_TOKEN }}
tag: v1.12.15
tag: v1.13.4

- name: Test KittenTTS
if: ${{ !startsWith(github.ref, 'refs/tags/') }}
shell: bash
run: |
SHERPA_ONNX_VERSION=v$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)

os=${{ matrix.os }}
arch=${{ matrix.arch }}
Expand Down
262 changes: 262 additions & 0 deletions .github/workflows/run-java-test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,3 +400,265 @@ jobs:
with:
name: tts-wav-files-${{ matrix.os }}
path: java-api-examples/*.wav

run_maven_test:
runs-on: ${{ matrix.os }}
name: maven-${{ matrix.os }} ${{ matrix.arch }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
arch: "x64"
native_lib: linux-x64

- os: ubuntu-24.04-arm
arch: "arm64"
native_lib: linux-aarch64

- os: macos-latest
arch: "arm64"
native_lib: osx-aarch64

- os: macos-15-intel
arch: "x64"
native_lib: osx-x64

- os: windows-2022
arch: "x64"
native_lib: win-x64

steps:
- uses: actions/checkout@v4

- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '21'

- name: Show java version
shell: bash
run: |
java --version
javac --version

- name: Update pom.xml for this platform
shell: bash
run: |
cd java-api-examples/maven-examples

native_lib=${{ matrix.native_lib }}

# Comment out all native lib dependency blocks, then uncomment the target one
python3 << 'PYEOF'
import re

native_lib = "${{ matrix.native_lib }}"
target_artifact = f"sherpa-onnx-native-lib-{native_lib}"

with open("pom.xml", "r") as f:
content = f.read()

# Pattern to match a native lib dependency block (commented or not)
# Each block has a platform comment, then the dependency (possibly wrapped in <!-- -->)
pattern = re.compile(
r'( <!-- [A-Za-z][^\n]*-->\n)' # platform comment line
r'( <!--\n)?' # optional opening comment
r'( <dependency>\n'
r' <groupId>com\.github\.k2-fsa\.sherpa-onnx</groupId>\n'
r' <artifactId>(sherpa-onnx-native-lib-[^<]+)</artifactId>\n'
r' <version>[^<]+</version>\n'
r' </dependency>\n)'
r'( -->\n)?', # optional closing comment
re.MULTILINE
)

def replace_block(m):
comment_line = m.group(1)
dep_block = m.group(3)
artifact = m.group(4)

if artifact == target_artifact:
# Uncomment: return without comment markers
return comment_line + dep_block
else:
# Comment out: wrap in <!-- -->
return comment_line + " <!--\n" + dep_block + " -->\n"

content = pattern.sub(replace_block, content)

with open("pom.xml", "w") as f:
f.write(content)
PYEOF

- name: Show pom.xml for debugging
shell: bash
run: |
cat java-api-examples/maven-examples/pom.xml

- name: Build maven example
shell: bash
run: |
cd java-api-examples/maven-examples
mvn package

ls -lh target/*.jar

- name: Verify jar contents
shell: bash
run: |
cd java-api-examples/maven-examples

echo "=== Jar size ==="
ls -lh target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar

echo "=== Native libs in jar ==="
unzip -l target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar | grep -E "\.so$|\.dylib$|\.dll$" || true

Comment on lines +515 to +517

@coderabbitai coderabbitai Bot Jul 22, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Native-lib verification step can't actually fail.

grep ... || true means this step always exits 0 even when zero native binaries are found in the jar, so it silently passes regardless of whether the jar actually bundles the expected .so/.dylib/.dll. Since the stated purpose of this step is to verify native binaries are present, an empty match should fail the job (e.g., assert non-zero line count) rather than be swallowed.

✅ Suggested fix 
-          echo "=== Native libs in jar ==="
-          unzip -l target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar | grep -E "\.so$|\.dylib$|\.dll$" || true
+          echo "=== Native libs in jar ==="
+          unzip -l target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar | grep -E "\.so$|\.dylib$|\.dll$"

Also applies to: 657-659

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/run-java-test.yaml around lines 515 - 517, Update the
native-library verification commands near the “Native libs in jar” checks to
fail when the archive contains no .so, .dylib, or .dll entries. Remove the
unconditional `|| true` suppression and add an explicit non-empty match
assertion, preserving successful execution when at least one native library is
found; apply the same change to both verification locations.

- name: Run maven example
shell: bash
run: |
cd java-api-examples/maven-examples
java -jar target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar

run_maven_test_approach1:
runs-on: ${{ matrix.os }}
name: maven-approach1-${{ matrix.os }} ${{ matrix.arch }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
arch: "x64"

- os: ubuntu-24.04-arm
arch: "arm64"

- os: macos-latest
arch: "arm64"

- os: macos-15-intel
arch: "x64"

- os: windows-2022
arch: "x64"

steps:
- uses: actions/checkout@v4

- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '21'

- name: Show java version
shell: bash
run: |
java --version
javac --version

- name: Write pom.xml for Approach 1
shell: bash
run: |
cd java-api-examples/maven-examples

cat > pom.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.k2fsa.sherpa.onnx</groupId>
<artifactId>sherpa-onnx-maven-example</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>

<name>sherpa-onnx Maven Example</name>
<description>Example project demonstrating how to use sherpa-onnx via Maven</description>

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.github.k2-fsa</groupId>
<artifactId>sherpa-onnx</artifactId>
<version>refactor-jar-SNAPSHOT</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<configuration>
<archive>
<manifest>
<mainClass>com.k2fsa.sherpa.onnx.example.VersionTest</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.5.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
EOF

- name: Show pom.xml for debugging
shell: bash
run: |
cat java-api-examples/maven-examples/pom.xml

- name: Build maven example (Approach 1)
shell: bash
run: |
cd java-api-examples/maven-examples
mvn package

ls -lh target/*.jar

- name: Verify jar contents
shell: bash
run: |
cd java-api-examples/maven-examples

echo "=== Jar size ==="
ls -lh target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar

echo "=== Native libs in jar ==="
unzip -l target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar | grep -E "\.so$|\.dylib$|\.dll$" || true

- name: Run maven example
shell: bash
run: |
cd java-api-examples/maven-examples
java -jar target/sherpa-onnx-maven-example-1.0-SNAPSHOT.jar
2 changes: 2 additions & 0 deletions java-api-examples/maven-examples/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dependency-reduced-pom.xml
target
Loading