Release 1.12.11 - #2547
Release 1.12.11#2547
Conversation
dosubot
Bot
added
the
size:M
WalkthroughRepository-wide version bump to 1.12.11 across build scripts, manifests, and examples; documentation updated accordingly. Android/Harmony/Flutter/Dart/Node package versions and dependencies updated. iOS build script version strings bumped. C++: add default false for the debug parameter in OfflineTtsZipvoiceFrontend constructors. Version metadata strings updated. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant App
participant OfflineTtsZipvoiceFrontend
Note over App,OfflineTtsZipvoiceFrontend: Construction with optional debug flag (default false)
App->>OfflineTtsZipvoiceFrontend: new(tokens, data_dir, pinyin_dict, meta_data[, debug])
OfflineTtsZipvoiceFrontend-->>App: instance
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This pull request bumps the sherpa-onnx library version from 1.12.10 to 1.12.11 across all project files and configuration files.
- Updates version strings, build codes, and package dependencies throughout the codebase
- Updates git metadata (commit SHA and date) in the version file
- Adds changelog entries for version 1.12.11 with new features and fixes
Reviewed Changes
Copilot reviewed 56 out of 56 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sherpa-onnx/csrc/version.cc | Updates git metadata and version string to 1.12.11 |
| sherpa-onnx/csrc/offline-tts-zipvoice-frontend.cc | Adds default parameter value comments to constructor signatures |
| setup.py | Updates sherpa-onnx-core dependency to version 1.12.11 |
| scripts/wheel/sherpa-onnx-core/setup.py | Updates package version to 1.12.11 |
| scripts/wheel/sherpa-onnx-bin/setup.py | Updates package and dependency versions to 1.12.11 |
| pom.xml | Updates Maven artifact version to 1.12.11 |
| nodejs-examples/package.json | Updates sherpa-onnx dependency to version 1.12.11 |
| nodejs-addon-examples/package.json | Updates sherpa-onnx-node dependency to version 1.12.11 |
| new-release.sh | Updates version codes and version strings for the release script |
| mfc-examples/README.md | Updates download URLs to point to v1.12.11 releases |
| jitpack.yml | Updates download URLs and Maven installation commands for v1.12.11 |
| harmony-os/*/oh-package.json5 | Updates sherpa_onnx dependency versions across HarmonyOS projects |
| harmony-os/SherpaOnnxVadAsr/entry/README.md | Updates HAR file reference to v1.12.11 |
| harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets | Updates HAR_VERSION constant to 1.12.11 |
| flutter/*/pubspec.yaml | Updates Flutter package versions and dependencies to 1.12.11 |
| build-ios-shared.sh | Updates iOS framework version string to 1.12.11 |
| android//build.gradle | Updates Android app version codes and names across all projects |
| android/SherpaOnnxAar/README.md | Updates download URLs and file references to v1.12.11 |
| CMakeLists.txt | Updates SHERPA_ONNX_VERSION variable to 1.12.11 |
| CHANGELOG.md | Adds comprehensive changelog entry for version 1.12.11 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| const std::string &tokens, const std::string &data_dir, | ||
| const std::string &pinyin_dict, | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug) | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug /*= false*/) |
There was a problem hiding this comment.
Adding default parameter values in implementation files rather than header files is not recommended. Default parameter values should be specified in the header file declaration, not in the implementation.
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug /*= false*/) | |
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug) |
| AAssetManager *mgr, const std::string &tokens, const std::string &data_dir, | ||
| const std::string &pinyin_dict, | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data); | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug = false); |
There was a problem hiding this comment.
Template specialization declarations should not include default parameter values. Default values should only be specified in the primary template declaration in the header file.
| NativeResourceManager *mgr, const std::string &tokens, | ||
| const std::string &data_dir, const std::string &pinyin_dict, | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data); | ||
| const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug = false); |
There was a problem hiding this comment.
Template specialization declarations should not include default parameter values. Default values should only be specified in the primary template declaration in the header file.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
build-ios-shared.sh (1)
22-26: Bug: environment variable check always true; quoting missing.The current test treats the literal string as non-empty, forcing ON every time.
-if [ ! -z CMAKE_VERBOSE_MAKEFILE ]; then - CMAKE_VERBOSE_MAKEFILE=ON -else - CMAKE_VERBOSE_MAKEFILE=OFF -fi +if [ -n "${CMAKE_VERBOSE_MAKEFILE:-}" ]; then + CMAKE_VERBOSE_MAKEFILE="${CMAKE_VERBOSE_MAKEFILE}" +else + CMAKE_VERBOSE_MAKEFILE=OFF +fiandroid/SherpaOnnxTts/app/build.gradle (1)
37-41: Remove legacy support ConstraintLayoutYou’re mixing support-era and AndroidX ConstraintLayout. Drop the old artifact to avoid conflicts.
- implementation 'com.android.support.constraint:constraint-layout:1.1.3' implementation 'androidx.core:core-ktx:1.7.0' implementation 'com.google.android.material:material:1.9.0' implementation 'androidx.constraintlayout:constraintlayout:2.1.4'sherpa-onnx/csrc/offline-tts-zipvoice-frontend.cc (1)
366-372: Default arguments are illegal in explicit instantiation declarations.bool debug = false in explicit template instantiations will not compile. Remove the = false; defaults belong only in the header declarations.
Apply:
#if __ANDROID_API__ >= 9 template OfflineTtsZipvoiceFrontend::OfflineTtsZipvoiceFrontend( AAssetManager *mgr, const std::string &tokens, const std::string &data_dir, const std::string &pinyin_dict, - const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug = false); + const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug); #endif #if __OHOS__ template OfflineTtsZipvoiceFrontend::OfflineTtsZipvoiceFrontend( NativeResourceManager *mgr, const std::string &tokens, const std::string &data_dir, const std::string &pinyin_dict, - const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug = false); + const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug); #endifAlso applies to: 374-380
🧹 Nitpick comments (23)
android/SherpaOnnxSimulateStreamingAsrWearOs/app/build.gradle.kts (2)
61-61: Ensure the JitPack artifact v1.12.11 is published before merging.The dependency points to com.github.k2-fsa:sherpa-onnx:v1.12.11. If JitPack hasn’t built the tag yet, CI/builds will fail. Consider pre-warming JitPack or mirroring to Maven Central if available.
42-43: Optional: align Compose compiler with your BOM/AGP.Hard-coding kotlinCompilerExtensionVersion = "1.5.1" can drift from the Compose BOM. If you’re on AGP 8.1+, prefer removing this pin and letting the Compose compiler plugin manage the version, or update it to match the BOM.
harmony-os/SherpaOnnxHar/sherpa_onnx/README.md (1)
30-30: Optional: add a note about matching the native/JNI libs.A brief reminder that Harmony projects should use the matching 1.12.11 binaries helps avoid ABI/version mismatches.
nodejs-examples/package.json (1)
5-5: Optional: confirm prebuilt binaries/ABI coverage.If the addon ships prebuilds, confirm 1.12.11 covers current Node LTS/ABI to avoid build-from-source in examples.
dart-api-examples/streaming-asr/pubspec.yaml (1)
14-14: Optional: run dart pub upgrade --major-versions in CI for the examples.Catches resolution issues early across all Dart examples after the bump.
harmony-os/SherpaOnnxVadAsr/entry/README.md (1)
3-4: Minor grammar/style: join into one sentence and drop “./”.Improves readability and avoids implying a relative path.
Apply:
-Please download ./sherpa_onnx-v1.12.11.har -from <https://huggingface.co/csukuangfj/sherpa-onnx-harmony-os/tree/main/har> +Please download sherpa_onnx-v1.12.11.har from <https://huggingface.co/csukuangfj/sherpa-onnx-harmony-os/tree/main/har>.android/SherpaOnnx2Pass/app/build.gradle (1)
8-13: Optional: consider modern SDK targets.compileSdk/targetSdk are 32; consider bumping to current (e.g., 34/35) if publishing to Play.
build-ios-shared.sh (3)
245-245: CFBundleShortVersionString updated to 1.12.11.Nice. Optional: inject the version via a variable to avoid future manual edits.
- <string>1.12.11</string> + <string>${SHERPA_ONNX_VERSION}</string>Outside this hunk, define once near the top:
# at the top, after set -e SHERPA_ONNX_VERSION="${SHERPA_ONNX_VERSION:-1.12.11}"
18-20: Typo in env var name: MIRROW → MIRROR (keep backward compat).This likely prevents the mirror toggle from working as intended.
-if [ "$SHERPA_ONNX_GITHUB_MIRROW" == true ]; then - SHERPA_ONNX_GITHUB=hub.nuaa.cf -fi +if [ "${SHERPA_ONNX_GITHUB_MIRROR:-false}" = true ] || [ "${SHERPA_ONNX_GITHUB_MIRROW:-false}" = true ]; then + SHERPA_ONNX_GITHUB=hub.nuaa.cf +fi
156-156: Nit: stray double slash in path.No functional impact; tidy for consistency.
-cp -v .//build/simulator_x86_64/install/lib/libsherpa-onnx-c-api.dylib ios-x86_64-simulator/ +cp -v ./build/simulator_x86_64/install/lib/libsherpa-onnx-c-api.dylib ios-x86_64-simulator/android/SherpaOnnxVadAsr/app/build.gradle (1)
6-16: Align SDK levels across Android modules (optional)
android/SherpaOnnxVadAsr/app/build.gradleusescompileSdk 33andtargetSdk 33, while all other Android modules target SDK 34; consider bumping this module to 34 to reduce build-matrix fragmentation.CHANGELOG.md (1)
3-14: Changelog wording/capitalization nits for consistency.
Minor style fixes: proper nouns and acronyms (Go, TTS, WASM, KWS, Win32, Hugging Face, C API).-* Fix releasing go packages (#2529) -* Add license info about tts models from OpenVoiceOS (#2530) +* Fix releasing Go packages (#2529) +* Add license info about TTS models from OpenVoiceOS (#2530) * Support BPE models with byte fallback. (#2531) -* Simplify the usage of our non-Android Java API (#2533) -* Fix wasm for kws (#2535) +* Simplify usage of the non-Android Java API. (#2533) +* Fix WASM for KWS. (#2535) * Add one more German tts model from OpenVoiceOS. (#2536) -* Fix uploading win32 libs to huggingface (#2537) +* Fix uploading Win32 libs to Hugging Face. (#2537) * Add Zipvoice (#2487) -* Fix c api (#2545) +* Fix C API. (#2545) * Fix linking (#2546)android/SherpaOnnxTts/app/build.gradle (1)
8-13: Align compileSdk/targetSdk with other modules (34)Other Android modules target/compile 34. Consider updating for consistency and modern API behavior.
Apply:
- compileSdk 32 + compileSdk 34 @@ - targetSdk 32 + targetSdk 34sherpa-onnx/csrc/version.cc (2)
10-10: Version metadata updated correctlyGit date/SHA and version string match the 1.12.11 release.
Consider generating these via build defs (e.g., -DVERSION, git describe) to reduce manual edits.
Also applies to: 15-15, 20-20
1-1: Minor header comment nitFile header says version.h while this is version.cc.
-// sherpa-onnx/csrc/version.h +// sherpa-onnx/csrc/version.ccmfc-examples/README.md (1)
8-10: Updated links look right; confirm assets existPlease double-check that all v1.12.11 x64/x86 assets are published before merging. Also consider replacing “URL” with the actual filenames for clarity.
android/SherpaOnnx/app/build.gradle (1)
14-15: Align compileSdk and targetSdk to API level 34 across all modules. Modules currently targeting API 32 (SherpaOnnx/app,SherpaOnnxWebSocket,SherpaOnnxTts,SherpaOnnxKws,SherpaOnnx2Pass) and API 33 (SherpaOnnxVadAsr,SherpaOnnxVad) should be updated to 34 for consistency.jitpack.yml (1)
5-9: Switch wget/mvn install to use a version variable and retry; add checksum verification.Improves reliability of JitPack builds when artifacts are briefly unavailable.
Apply:
-before_install: - - wget https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.11/sherpa-onnx-1.12.11.aar +before_install: + - VERSION=${VERSION:-1.12.11} + - curl -fL --retry 5 --retry-delay 2 -o sherpa-onnx-${VERSION}.aar https://github.com/k2-fsa/sherpa-onnx/releases/download/v${VERSION}/sherpa-onnx-${VERSION}.aar + # optional: verify checksum if published alongside the AAR + # - curl -fL -o sherpa-onnx-${VERSION}.aar.sha256 https://github.com/k2-fsa/sherpa-onnx/releases/download/v${VERSION}/sherpa-onnx-${VERSION}.aar.sha256 + # - sha256sum -c sherpa-onnx-${VERSION}.aar.sha256 install: - - FILE="-Dfile=sherpa-onnx-1.12.11.aar" - - mvn install:install-file $FILE -DgroupId=com.k2fsa.sherpa.onnx -DartifactId=sherpa-onnx -Dversion=1.12.11 -Dpackaging=aar -DgeneratePom=true + - FILE="-Dfile=sherpa-onnx-${VERSION}.aar" + - mvn -B install:install-file $FILE -DgroupId=com.k2fsa.sherpa.onnx -DartifactId=sherpa-onnx -Dversion=${VERSION} -Dpackaging=aar -DgeneratePom=trueandroid/SherpaOnnxWebSocket/app/build.gradle (1)
8-8: Optional: align compileSdk/targetSdk to 34 for consistency across apps.
This module still uses 32; consider moving to 34 to match newer modules and reduce fragmentation.Also applies to: 13-13
android/SherpaOnnxKws/app/build.gradle (1)
8-8: Optional: update compileSdk/targetSdk to 34.
Brings this sample in line with the modules already on API 34.Also applies to: 13-13
android/SherpaOnnxJavaDemo/app/build.gradle (1)
31-36: Optional: refresh AndroidX deps to match compileSdk 34.Current libraries are several years old; upgrading reduces compatibility issues with API 34.
Suggested updates:
-implementation 'androidx.appcompat:appcompat:1.3.1' -implementation 'com.google.android.material:material:1.3.0' -implementation 'androidx.constraintlayout:constraintlayout:1.1.3' -implementation 'androidx.core:core-ktx:1.7.0' +implementation 'androidx.appcompat:appcompat:1.7.0' +implementation 'com.google.android.material:material:1.12.0' +implementation 'androidx.constraintlayout:constraintlayout:2.1.4' +implementation 'androidx.core:core-ktx:1.13.1'sherpa-onnx/csrc/offline-tts-zipvoice-frontend.cc (1)
199-204: Minor: remove inline /= false/ comment in the definition.Defaults are already declared in the header; keeping comments here can confuse readers.
- const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug /*= false*/) + const OfflineTtsZipvoiceModelMetaData &meta_data, bool debug)harmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5 (1)
9-9: Optional: standardize trailing-comma style across Harmony OS manifests.Other oh-package.json5 files keep a trailing comma after the last dependency; this one does not. Consider aligning for consistency.
Apply this if you prefer trailing commas:
- "sherpa_onnx": "1.12.11" + "sherpa_onnx": "1.12.11",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (56)
CHANGELOG.md(1 hunks)CMakeLists.txt(1 hunks)android/SherpaOnnx/app/build.gradle(1 hunks)android/SherpaOnnx2Pass/app/build.gradle(1 hunks)android/SherpaOnnxAar/README.md(2 hunks)android/SherpaOnnxAudioTagging/app/build.gradle.kts(1 hunks)android/SherpaOnnxAudioTaggingWearOs/app/build.gradle.kts(1 hunks)android/SherpaOnnxJavaDemo/app/build.gradle(2 hunks)android/SherpaOnnxKws/app/build.gradle(1 hunks)android/SherpaOnnxSimulateStreamingAsr/app/build.gradle.kts(1 hunks)android/SherpaOnnxSimulateStreamingAsrWearOs/app/build.gradle.kts(2 hunks)android/SherpaOnnxSpeakerDiarization/app/build.gradle.kts(1 hunks)android/SherpaOnnxSpeakerIdentification/app/build.gradle.kts(1 hunks)android/SherpaOnnxSpokenLanguageIdentification/app/build.gradle.kts(1 hunks)android/SherpaOnnxTts/app/build.gradle(1 hunks)android/SherpaOnnxTtsEngine/app/build.gradle.kts(1 hunks)android/SherpaOnnxVad/app/build.gradle(1 hunks)android/SherpaOnnxVadAsr/app/build.gradle(1 hunks)android/SherpaOnnxWebSocket/app/build.gradle(1 hunks)build-ios-shared.sh(1 hunks)dart-api-examples/add-punctuations/pubspec.yaml(1 hunks)dart-api-examples/audio-tagging/pubspec.yaml(1 hunks)dart-api-examples/keyword-spotter/pubspec.yaml(1 hunks)dart-api-examples/non-streaming-asr/pubspec.yaml(1 hunks)dart-api-examples/speaker-diarization/pubspec.yaml(1 hunks)dart-api-examples/speaker-identification/pubspec.yaml(1 hunks)dart-api-examples/speech-enhancement-gtcrn/pubspec.yaml(1 hunks)dart-api-examples/streaming-asr/pubspec.yaml(1 hunks)dart-api-examples/tts/pubspec.yaml(1 hunks)dart-api-examples/vad-with-non-streaming-asr/pubspec.yaml(1 hunks)dart-api-examples/vad/pubspec.yaml(1 hunks)flutter-examples/streaming_asr/pubspec.yaml(2 hunks)flutter-examples/tts/pubspec.yaml(2 hunks)flutter/sherpa_onnx/pubspec.yaml(2 hunks)flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec(1 hunks)flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec(1 hunks)harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets(2 hunks)harmony-os/SherpaOnnxHar/sherpa_onnx/README.md(1 hunks)harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5(1 hunks)harmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5(1 hunks)harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5(1 hunks)harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5(1 hunks)harmony-os/SherpaOnnxTts/entry/oh-package.json5(1 hunks)harmony-os/SherpaOnnxVadAsr/entry/README.md(1 hunks)harmony-os/SherpaOnnxVadAsr/entry/oh-package.json5(1 hunks)jitpack.yml(1 hunks)mfc-examples/README.md(1 hunks)new-release.sh(1 hunks)nodejs-addon-examples/package.json(1 hunks)nodejs-examples/package.json(1 hunks)pom.xml(1 hunks)scripts/wheel/sherpa-onnx-bin/setup.py(2 hunks)scripts/wheel/sherpa-onnx-core/setup.py(1 hunks)setup.py(1 hunks)sherpa-onnx/csrc/offline-tts-zipvoice-frontend.cc(2 hunks)sherpa-onnx/csrc/version.cc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-06T04:23:50.237Z
Learnt from: litongjava
PR: k2-fsa/sherpa-onnx#2440
File: sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/core/Core.java:4-6
Timestamp: 2025-08-06T04:23:50.237Z
Learning: The sherpa-onnx JNI library files are stored in Hugging Face repository at https://huggingface.co/csukuangfj/sherpa-onnx-libs under versioned directories like jni/1.12.7/, and the actual Windows JNI library filename is "sherpa-onnx-jni.dll" as defined in Core.java constants.
Applied to files:
harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5sherpa-onnx/csrc/version.ccdart-api-examples/vad/pubspec.yamljitpack.ymldart-api-examples/speaker-diarization/pubspec.yamldart-api-examples/add-punctuations/pubspec.yamlflutter/sherpa_onnx/pubspec.yamlharmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5pom.xmlharmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5mfc-examples/README.mdharmony-os/SherpaOnnxTts/entry/oh-package.json5dart-api-examples/keyword-spotter/pubspec.yamlharmony-os/SherpaOnnxHar/sherpa_onnx/README.mdharmony-os/SherpaOnnxVadAsr/entry/oh-package.json5dart-api-examples/speaker-identification/pubspec.yamldart-api-examples/vad-with-non-streaming-asr/pubspec.yamldart-api-examples/audio-tagging/pubspec.yamlflutter-examples/streaming_asr/pubspec.yamlandroid/SherpaOnnxAar/README.mdharmony-os/SherpaOnnxVadAsr/entry/README.md
📚 Learning: 2025-08-06T04:18:47.981Z
Learnt from: litongjava
PR: k2-fsa/sherpa-onnx#2440
File: sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/core/Core.java:4-6
Timestamp: 2025-08-06T04:18:47.981Z
Learning: In sherpa-onnx Java API, the native library names in Core.java (WIN_NATIVE_LIBRARY_NAME = "sherpa-onnx-jni.dll", UNIX_NATIVE_LIBRARY_NAME = "libsherpa-onnx-jni.so", MACOS_NATIVE_LIBRARY_NAME = "libsherpa-onnx-jni.dylib") are copied directly from the compiled binary filenames and should not be changed to match other libraries' naming conventions.
Applied to files:
sherpa-onnx/csrc/version.ccpom.xmlandroid/SherpaOnnxAar/README.md
🧬 Code graph analysis (2)
setup.py (1)
cmake/cmake_extension.py (1)
need_split_package(16-18)
sherpa-onnx/csrc/offline-tts-zipvoice-frontend.cc (1)
sherpa-onnx/csrc/offline-tts-zipvoice-frontend.h (1)
OfflineTtsZipvoiceFrontend(19-58)
🪛 LanguageTool
CHANGELOG.md
[grammar] ~4-~4: There might be a mistake here.
Context: ...samples for MatchaTTS (English). (#2527) * Fix releasing go packages (#2529) * Add ...
(QB_NEW_EN)
[grammar] ~5-~5: There might be a mistake here.
Context: ...527) * Fix releasing go packages (#2529) * Add license info about tts models from O...
(QB_NEW_EN)
[grammar] ~6-~6: There might be a mistake here.
Context: ...bout tts models from OpenVoiceOS (#2530) * Support BPE models with byte fallback. (...
(QB_NEW_EN)
[grammar] ~7-~7: There might be a mistake here.
Context: ...t BPE models with byte fallback. (#2531) * Simplify the usage of our non-Android Ja...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...rman tts model from OpenVoiceOS. (#2536) * Fix uploading win32 libs to huggingface ...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...oading win32 libs to huggingface (#2537) * Add Zipvoice (#2487) * Fix c api (#2545)...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...ggingface (#2537) * Add Zipvoice (#2487) * Fix c api (#2545) * Fix linking (#2546) ...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...Add Zipvoice (#2487) * Fix c api (#2545) * Fix linking (#2546) ## 1.12.10 * Add V...
(QB_NEW_EN)
harmony-os/SherpaOnnxVadAsr/entry/README.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...ease download ./sherpa_onnx-v1.12.11.har from <https://huggingface.co/csukuangfj/...
(QB_NEW_EN)
🔇 Additional comments (48)
android/SherpaOnnxSimulateStreamingAsrWearOs/app/build.gradle.kts (1)
14-16: Version bump looks consistent and correct.versionCode 20250901 and versionName "1.12.11" align with the release. No issues.
harmony-os/SherpaOnnxHar/sherpa_onnx/README.md (1)
25-27: Docs version updated correctly."sherpa_onnx": "1.12.11" matches the release. LGTM.
dart-api-examples/speech-enhancement-gtcrn/pubspec.yaml (2)
13-13: Dart dependency bump is correct.sherpa_onnx ^1.12.11 matches the repo-wide version update.
13-13: Verify pub.dev availability before tagging the release.Ensure sherpa_onnx 1.12.11 is published on pub.dev so examples resolve without path overrides.
nodejs-examples/package.json (1)
5-5: Node dependency bump looks good."sherpa-onnx": "^1.12.11" aligns with the release.
dart-api-examples/streaming-asr/pubspec.yaml (1)
14-14: Dependency version updated correctly.Matches the 1.12.11 release.
dart-api-examples/speaker-diarization/pubspec.yaml (1)
11-11: Version bump LGTM. Dependency updated to sherpa_onnx ^1.12.11; consistent with the release scope. Unable to rundart pub gethere (dartnot found); please verify locally thatdart pub getsucceeds without errors.dart-api-examples/vad-with-non-streaming-asr/pubspec.yaml (1)
13-13: Version bump LGTM; verify dependency resolution locally
Matches the repo-wide upgrade to 1.12.11. After installing the Dart SDK, rundart pub getindart-api-examples/vad-with-non-streaming-asrto confirm no errors.dart-api-examples/add-punctuations/pubspec.yaml (1)
12-12: Approve sherpa_onnx version bump
No API changes in the Dart example; please verify locally thatdart pub getcompletes without errors.android/SherpaOnnxSpeakerDiarization/app/build.gradle.kts (1)
14-15: LGTM on versionCode/versionName bump.
Monotonic versionCode (20250901) and name 1.12.11 align with the release date/version.android/SherpaOnnxAudioTagging/app/build.gradle.kts (1)
14-15: Version metadata bump looks consistent.
No other config changes; safe for release track.dart-api-examples/vad/pubspec.yaml (1)
12-12: Version bump looks good.No issues with the constraint update to ^1.12.11.
android/SherpaOnnx2Pass/app/build.gradle (1)
14-15: Android versionCode/versionName updated correctly.Change is consistent with the 1.12.11 release date (2025-09-01).
dart-api-examples/tts/pubspec.yaml (1)
11-11: Dependency bump acknowledged.Matches the repo-wide 1.12.11 update.
dart-api-examples/keyword-spotter/pubspec.yaml (1)
12-12: LGTM on sherpa_onnx ^1.12.11.Commented local path override remains intact for dev workflows.
android/SherpaOnnxSpokenLanguageIdentification/app/build.gradle.kts (1)
14-15: Version bump is consistent with 1.12.11.versionCode 20250901 and versionName "1.12.11" look good and monotonic.
flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec (1)
10-10: Verify podspec withpod lib lint
Runpod lib lint flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec --allow-warningslocally to confirm the updated version passes validation.flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec (1)
7-7: macOS Podspec version bumped to 1.12.11; please validate with CocoaPods lint locally
Automated lint failed (podCLI not installed). Run:pod lib lint flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec --allow-warningsandroid/SherpaOnnxVadAsr/app/build.gradle (1)
14-15: Version bump OK.versionCode 20250901 / versionName "1.12.11" are consistent.
pom.xml (2)
7-7: LGTM: version bump to 1.12.11.
No functional changes; matches the repo-wide release.
7-7: Version consistency verified across all artifacts. Scanned POM, setup scripts, CMakeLists, Jitpack, package.json, pubspec.yaml, podspecs, and Gradle files—every reference is 1.12.11.dart-api-examples/non-streaming-asr/pubspec.yaml (1)
13-13: Dart dep bump looks good.
sherpa_onnx: ^1.12.11aligns with the release.flutter-examples/tts/pubspec.yaml (1)
8-8: Example app version bumped — OK.
Matches the library release tag.flutter/sherpa_onnx/pubspec.yaml (2)
33-49: Platform package pins updated — OK.
All platform-specific sherpa_onnx* deps set to ^1.12.11.
20-20: No action required: macOS podspec version is already 1.12.11android/SherpaOnnxTtsEngine/app/build.gradle.kts (1)
14-15: Version bump LGTMDate-based versionCode and versionName look consistent for 1.12.11. Please ensure all Android modules use the same values for this release.
android/SherpaOnnxAudioTaggingWearOs/app/build.gradle.kts (1)
14-15: Version bump LGTMMatches the repo-wide 1.12.11 release scheme. Verify other Wear modules (if any) use the same date-based versionCode.
android/SherpaOnnxTts/app/build.gradle (1)
14-15: Version bump LGTMValues align with 1.12.11.
scripts/wheel/sherpa-onnx-bin/setup.py (1)
16-16: Bin wheel version bumped to 1.12.11 — OK.No functional changes beyond metadata.
flutter-examples/streaming_asr/pubspec.yaml (2)
8-8: Example app version updated to 1.12.11 — OK.
34-34: Confirmed all Flutter and Dart examples reference sherpa_onnx ^1.12.11.android/SherpaOnnxSpeakerIdentification/app/build.gradle.kts (1)
14-15: Version metadata bumped — OK.Matches repo-wide 1.12.11.
android/SherpaOnnxVad/app/build.gradle (2)
14-15: LGTM: version bump (20250901 / 1.12.11) is correct and consistent.
14-15: Android versionCode/versionName consistency verified
All app modules define versionCode = 20250901 and versionName = "1.12.11", and no versionCode exceeds 2 100 000 000.android/SherpaOnnxWebSocket/app/build.gradle (1)
14-15: LGTM: version bump aligns with 1.12.11.harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets (1)
4-4: LGTM: HAR_VERSION updated to 1.12.11.android/SherpaOnnxSimulateStreamingAsr/app/build.gradle.kts (1)
14-15: LGTM: version bump is correct.android/SherpaOnnxKws/app/build.gradle (2)
14-15: LGTM: version bump aligns with release 1.12.11.
14-15: Confirmed all Android modules use API 34
All app modules have bothcompileSdkandtargetSdkset to 34; no updates needed.android/SherpaOnnxAar/README.md (2)
19-20: LGTM: AAR artifact rename aligns with 1.12.11.
7-13: Prefixcpcommands with the extracted directory (e.g.sherpa-onnx-v1.12.11-android/jniLibs/...) orcd sherpa-onnx-v1.12.11-androidbefore copying.android/SherpaOnnxJavaDemo/app/build.gradle (1)
12-13: Version bump and dependency pin to v1.12.11 look good.Also applies to: 37-38
new-release.sh (1)
3-9: Approve changes. The only remaining occurrence of1.12.10is in CHANGELOG.md for historical record and is expected.harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5 (1)
9-9: No stale 1.12.10 references remain in code or lock files; version bump to 1.12.11 is approved.harmony-os/SherpaOnnxVadAsr/entry/oh-package.json5 (1)
10-10: LGTM on the dependency bump.The inline comment is fine for JSON5; trailing comma is valid.
harmony-os/SherpaOnnxTts/entry/oh-package.json5 (1)
9-9: Bump to 1.12.11 approved.JSON5 syntax is valid; no functional impact beyond the version update.
harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5 (1)
9-9: Looks good.Dependency updated to 1.12.11; matches the repo-wide release.
harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5 (1)
3-3: Version bump to 1.12.11 verified across all modules; no lingering “1.12.10” references found (aside from the prior changelog entry).
| versionCode 20250901 | ||
| versionName "1.12.11" |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Repo-wide consistency check for lingering old versions.
Run this to ensure no leftover 1.12.10 or old Android versionCodes remain.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Searching for leftover 1.12.10 references..."
rg -n --hidden -S '1\.12\.10' -g '!**/build/**' || true
echo "Searching Android modules for old versionCode patterns (e.g., 202508..)"
rg -nP --hidden -S 'versionCode\s+202508\d{2}' -g '!**/build/**' || true
echo "Confirm all versionName entries are 1.12.11"
rg -nP --hidden -S 'versionName\s+"1\.12\.11"' -g '!**/build/**' | wc -lLength of output: 774
Update lingering v1.12.10 references in CHANGELOG and workflows.
- CHANGELOG.md (line 16):
## 1.12.10 - .github/workflows/jar.yaml (line 221):
tag: v1.12.10 - .github/workflows/linux-jni.yaml (lines 73, 190):
tag: v1.12.10
🤖 Prompt for AI Agents
In android/SherpaOnnx2Pass/app/build.gradle around lines 14-15, the versionName
has been bumped to 1.12.11 but lingering references to v1.12.10 remain; update
CHANGELOG.md line 16 from "## 1.12.10" to "## 1.12.11", and update
.github/workflows/jar.yaml (line 221) and .github/workflows/linux-jni.yaml
(lines 73 and 190) to use tag: v1.12.11 so all release/version references match
the new version.
| # ./CHANGELOG.md | ||
| # ./new-release.sh | ||
| set(SHERPA_ONNX_VERSION "1.12.10") | ||
| set(SHERPA_ONNX_VERSION "1.12.11") |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Version bump looks good; run a quick sweep for stale 1.12.10 references.
Prevents mixed-version strings across templates/scripts.
🏁 Script executed:
#!/bin/bash
# Find any lingering 1.12.10 occurrences
rg -n --hidden -S "1\.12\.10" -g '!.git' -g '!**/build/**' -g '!**/dist/**'Length of output: 282
Update remaining 1.12.10 references to 1.12.11
Stale tags detected—please bump these to 1.12.11 to keep CI and docs in sync:
- CHANGELOG.md:16 (
## 1.12.10) - .github/workflows/linux-jni.yaml:73 (
tag: v1.12.10) - .github/workflows/linux-jni.yaml:190 (
# tag: v1.12.10) - .github/workflows/jar.yaml:221 (
tag: v1.12.10)
🤖 Prompt for AI Agents
In CMakeLists.txt around line 17 and the other files listed (CHANGELOG.md line
~16, .github/workflows/linux-jni.yaml lines ~73 and ~190, and
.github/workflows/jar.yaml around line ~221), stale version references still
point to 1.12.10; update each occurrence to 1.12.11 so CI tags and changelog
match the CMake set(SHERPA_ONNX_VERSION "1.12.11") change — specifically change
the CHANGELOG header from "## 1.12.10" to "## 1.12.11" and replace tag: v1.12.10
(and commented # tag: v1.12.10) with tag: v1.12.11 in the two workflow files and
update the jar workflow tag to v1.12.11.
|
|
||
| dependencies: | ||
| sherpa_onnx: ^1.12.10 | ||
| sherpa_onnx: ^1.12.11 |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
LGTM; same publication check recommended.
Preempt failures in example builds if 1.12.11 isn’t yet live on pub.dev.
🏁 Script executed:
#!/bin/bash
curl -s https://pub.dev/api/packages/sherpa_onnx | jq -r '.latest.version'Length of output: 82
Downgrade sherpa_onnx to the latest published version
In dart-api-examples/audio-tagging/pubspec.yaml (line 12), change
sherpa_onnx: ^1.12.11to
sherpa_onnx: ^1.12.10since 1.12.11 isn’t yet available on pub.dev.
🤖 Prompt for AI Agents
In dart-api-examples/audio-tagging/pubspec.yaml around line 12, the sherpa_onnx
dependency is set to a version that isn't published (1.12.11); change the
version specifier to the latest published release by replacing ^1.12.11 with
^1.12.10 in the dependencies section so pub get can resolve the package.
|
|
||
| dependencies: | ||
| sherpa_onnx: ^1.12.10 | ||
| sherpa_onnx: ^1.12.11 |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Dependency constraint updated correctly.
Please ensure sherpa_onnx 1.12.11 is published on pub.dev before merging to avoid CI breakage.
🏁 Script executed:
#!/bin/bash
# Verify latest published version on pub.dev
curl -s https://pub.dev/api/packages/sherpa_onnx | jq -r '.latest.version'Length of output: 82
Wait for sherpa_onnx 1.12.11 to be published or revert to ^1.12.10
Pub.dev’s latest sherpa_onnx release is 1.12.10; 1.12.11 isn’t available and will break CI. Either publish 1.12.11 or update the constraint back to ^1.12.10 before merging.
🤖 Prompt for AI Agents
In dart-api-examples/speaker-identification/pubspec.yaml around line 12, the
dependency constraint pins sherpa_onnx to ^1.12.11 which is not yet published on
pub.dev and will break CI; change the constraint back to ^1.12.10 (or the latest
published version) OR wait until sherpa_onnx 1.12.11 is published and then
update the file; update pubspec.yaml accordingly and run a quick pub get to
verify resolution.
| path_provider: ^2.1.3 | ||
| path: ^1.9.0 | ||
| sherpa_onnx: ^1.12.10 | ||
| sherpa_onnx: ^1.12.11 |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Dependency bump to ^1.12.11 approved.
Ensure pub get succeeds in CI.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Validate flutter-examples/tts resolves dependencies"
( cd flutter-examples/tts && dart pub outdated || true )Length of output: 280
🏁 Script executed:
#!/bin/bash
set -euo pipefail
if [ -d .github/workflows ]; then
echo "CI workflows:"
find .github/workflows -type f -name '*.yml' -o -name '*.yaml'
echo "Searching for 'pub get' in workflows"
grep -R "pub get" -n .github/workflows || true
else
echo "No workflows directory"
fiLength of output: 7391
🏁 Script executed:
#!/bin/bash
set -euo pipefail
sed -n '1,200p' .github/workflows/test-dart-package.yamlLength of output: 3217
🏁 Script executed:
#!/bin/bash
set -euo pipefail
grep -R "flutter-examples/tts" -n .github/workflows || trueLength of output: 78
🏁 Script executed:
#!/bin/bash
set -euo pipefail
sed -n '1,200p' .github/workflows/flutter-android.yamlLength of output: 4718
Add CI step to validate flutter-examples/tts dependencies
Current workflows don’t run flutter pub get (or dart pub get) in the flutter-examples/tts folder. Please add a job or step in CI to run pub get there and confirm the sherpa_onnx: ^1.12.11 bump resolves without errors.
🤖 Prompt for AI Agents
In flutter-examples/tts/pubspec.yaml around line 21, CI currently doesn't run
pub get for that folder so the sherpa_onnx: ^1.12.11 bump is not validated; add
a CI job or step that installs the appropriate SDK (Flutter or Dart) on the
runner, sets working-directory to flutter-examples/tts, and runs either flutter
pub get (if using Flutter) or dart pub get, failing the job on non-zero exit so
dependency resolution errors surface; ensure the step runs on the relevant
matrix/branch and caches pub packages if desired.
| { | ||
| "dependencies": { | ||
| "sherpa-onnx-node": "^1.12.10" | ||
| "sherpa-onnx-node": "^1.12.11" |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Node addon dependency bumped correctly.
If the examples run CI, consider verifying prebuilt binaries exist for 1.12.11 across target Node versions via a quick install step.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
npm view sherpa-onnx-node version
npm pack sherpa-onnx-node@1.12.11 >/dev/null
echo "sherpa-onnx-node@1.12.11 is retrievable from npm."Length of output: 451
sherpa-onnx-node@1.12.11 not published on npm
In nodejs-addon-examples/package.json (line 3), the dependency "^1.12.11" does not exist (npm shows latest as 1.12.10 and npm pack sherpa-onnx-node@1.12.11 fails). Change to "^1.12.10" or publish 1.12.11 before merging.
🤖 Prompt for AI Agents
In nodejs-addon-examples/package.json around line 3, the dependency version
"sherpa-onnx-node": "^1.12.11" references a package version that is not
published; update the dependency to a published version such as
"sherpa-onnx-node": "^1.12.10" (or alternatively publish 1.12.11 before merging)
so npm install/pack succeeds.
| data_files=[("Scripts", bin_files) if is_windows() else ("bin", bin_files)], | ||
| install_requires=[ | ||
| "sherpa-onnx-core==1.12.10", | ||
| "sherpa-onnx-core==1.12.11", |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Pin to sherpa-onnx-core 1.12.11 — ensure publish order.
Keep this strict pin, but publish core 1.12.11 before bin to avoid resolver failures; consider adding python_requires and long_description for PyPI metadata in a follow-up.
🏁 Script executed:
#!/bin/bash
# Verify core 1.12.11 exists on PyPI
curl -fsSL https://pypi.org/pypi/sherpa-onnx-core/json | jq '(.releases["1.12.11"]|length) // 0'Length of output: 100
Publish sherpa-onnx-core 1.12.11 before bin; version missing on PyPI
The pinned core version (1.12.11) isn’t released—PyPI shows no 1.12.11 artifacts. Publish sherpa-onnx-core 1.12.11 or update this pin to an existing release.
Optional: add python_requires and long_description metadata in setup.py.
| setup( | ||
| name="sherpa-onnx-core", | ||
| version="1.12.10", | ||
| version="1.12.11", |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Version bump OK; consider making data_files handling explicit.
Avoid passing None to data_files and precompute file list for clarity.
Apply:
def get_binaries():
if not is_windows():
- return None
+ return None
@@
-setup(
+files = get_binaries() or []
+setup(
@@
- data_files=[("Scripts", get_binaries())] if get_binaries() else None,
+ data_files=[("Scripts", files)] if files else [],Verify expected binaries exist for 1.12.11 before building the wheel:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
DIR="scripts/wheel/sherpa-onnx-core"
PREFIX="$DIR/sherpa_onnx/lib"
for f in onnxruntime.dll sherpa-onnx-c-api.dll sherpa-onnx-cxx-api.dll sherpa-onnx-c-api.lib sherpa-onnx-cxx-api.lib; do
[ -f "$PREFIX/$f" ] || { echo "Missing: $PREFIX/$f"; exit 1; }
done
echo "All expected Windows binaries are present."Length of output: 469
Missing Windows binaries in wheel package
The verification script reported that onnxruntime.dll is absent from scripts/wheel/sherpa-onnx-core/sherpa_onnx/lib, causing the Windows wheel build to fail. Add the required DLLs/libs or update get_binaries() to correctly include them.
| }, | ||
| license="Apache licensed, as found in the LICENSE file", | ||
| install_requires=["sherpa-onnx-core==1.12.10"] if need_split_package() else None, | ||
| install_requires=["sherpa-onnx-core==1.12.11"] if need_split_package() else None, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Pin looks correct; ensure sherpa-onnx-core 1.12.11 is available on PyPI.
To avoid install-time failures when SHERPA_ONNX_SPLIT_PYTHON_PACKAGE is set, verify the core wheel/tag exists.
Run:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
curl -s https://pypi.org/pypi/sherpa-onnx-core/json | jq -r '.releases | keys[]' | sort -V | tail -n 10Length of output: 195
Pin broken: sherpa-onnx-core==1.12.11 isn’t on PyPI
setup.py:104 pins to 1.12.11, but the latest published core releases are up to 1.12.10. This will cause install failures when SHERPA_ONNX_SPLIT_PYTHON_PACKAGE is set—either publish 1.12.11 or update the pin to an existing version.
🤖 Prompt for AI Agents
In setup.py around line 104 the install_requires pins sherpa-onnx-core==1.12.11
which is not on PyPI; replace that pin with a published version (e.g.,
sherpa-onnx-core==1.12.10) or change the conditional to a looser constraint
(e.g., "sherpa-onnx-core>=1.12.10,<1.13.0") so installs succeed when
SHERPA_ONNX_SPLIT_PYTHON_PACKAGE is set; alternatively, if 1.12.11 must be used,
ensure that version is published to PyPI before keeping the current pin.
Summary by CodeRabbit
New Features
Documentation
Chores