Release v1.12.5 #2368
Release v1.12.5 #2368
Conversation
WalkthroughThis update increments the project version from 1.12.4 to 1.12.5 across all code, documentation, build scripts, and dependency files. All references, download URLs, and metadata have been updated to reflect the new version. No changes were made to functionality, logic, or public interfaces in this set of changes. Changes
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project version from 1.12.4 to 1.12.5 across all relevant source files, build scripts, and example configurations, and adds the 1.12.5 entry to the changelog.
- Bump core library version in
version.cc, build scripts, and packaging manifests. - Update example dependencies and download URLs to 1.12.5.
- Add new changelog section for 1.12.5.
Reviewed Changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sherpa-onnx/csrc/version.cc | Update git date, SHA1, and version string |
| pom.xml | Bump Maven artifact version |
| nodejs-examples/package.json | Update sherpa-onnx dependency version |
| nodejs-addon-examples/package.json | Update sherpa-onnx-node dependency version |
| new-release.sh | Advance old/new version regex for 1.12.5 |
| mfc-examples/README.md | Update release download URLs to v1.12.5 |
| jitpack.yml | Change AAR download and install to v1.12.5 |
| harmony-os/SherpaOnnxVadAsr/entry/oh-package.json5 | Bump sherpa_onnx version |
| harmony-os/SherpaOnnxVadAsr/entry/README.md | Update HAR download file name to v1.12.5 |
| harmony-os/SherpaOnnxTts/entry/oh-package.json5 | Bump sherpa_onnx version |
| harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5 | Bump sherpa_onnx version |
| harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5 | Bump sherpa_onnx version |
| harmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5 | Bump sherpa_onnx version |
| harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5 | Bump package version |
| harmony-os/SherpaOnnxHar/sherpa_onnx/README.md | Update dependency snippet to 1.12.5 |
| harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets | Update HAR_VERSION constant |
| flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec | Bump CocoaPod version |
| flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec | Bump CocoaPod version |
| flutter/sherpa_onnx/pubspec.yaml | Update Dart package version and deps |
| flutter-examples/tts/pubspec.yaml | Bump example pubspec version |
| flutter-examples/streaming_asr/pubspec.yaml | Bump example pubspec version |
| dart-api-examples/vad/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/vad-with-non-streaming-asr/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/tts/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/streaming-asr/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/speech-enhancement-gtcrn/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/speaker-identification/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/speaker-diarization/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/non-streaming-asr/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/keyword-spotter/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/audio-tagging/pubspec.yaml | Update sherpa_onnx dependency version |
| dart-api-examples/add-punctuations/pubspec.yaml | Update sherpa_onnx dependency version |
| build-ios-shared.sh | Bump iOS framework version in plist output |
| android/SherpaOnnxJavaDemo/app/build.gradle | Update Gradle implementation line to v1.12.5 |
| android/SherpaOnnxAar/README.md | Update Android tarball URL and file name |
| CMakeLists.txt | Update SHERPA_ONNX_VERSION CMake variable |
| CHANGELOG.md | Add new section for version 1.12.5 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (2)
build-ios-shared.sh (2)
18-20: Typo in environment-variable name may break mirror logic.
SHERPA_ONNX_GITHUB_MIRROWis likely meant to beSHERPA_ONNX_GITHUB_MIRROR.
Downstream scripts/tools will silently ignore the wrong variable name.-if [ "$SHERPA_ONNX_GITHUB_MIRROW" == true ]; then +if [ "$SHERPA_ONNX_GITHUB_MIRROR" == true ]; then
22-26: Incorrect variable expansion test — always “true”.
[ ! -z CMAKE_VERBOSE_MAKEFILE ]tests the stringCMAKE_VERBOSE_MAKEFILE, not the
value of the variable. Use quotes around the expansion and the-ntest.-if [ ! -z CMAKE_VERBOSE_MAKEFILE ]; then - CMAKE_VERBOSE_MAKEFILE=ON +if [ -n "$CMAKE_VERBOSE_MAKEFILE" ]; then + CMAKE_VERBOSE_MAKEFILE=ON
♻️ Duplicate comments (8)
harmony-os/SherpaOnnxVadAsr/entry/oh-package.json5 (1)
8-11: Same verification applies as previous fileThe version bump is correct; just ensure v1.12.5 exists in the registry and no stray 1.12.4 references remain.
harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5 (1)
8-10: Same verification applies as previous fileharmony-os/SherpaOnnxTts/entry/oh-package.json5 (1)
8-10: Same verification applies as previous filedart-api-examples/audio-tagging/pubspec.yaml (1)
11-13: See comment inadd-punctuations/pubspec.yaml.dart-api-examples/speaker-identification/pubspec.yaml (1)
11-13: See comment inadd-punctuations/pubspec.yaml.dart-api-examples/vad-with-non-streaming-asr/pubspec.yaml (1)
11-13: See comment inadd-punctuations/pubspec.yaml.dart-api-examples/tts/pubspec.yaml (1)
10-12: See comment inadd-punctuations/pubspec.yaml.dart-api-examples/streaming-asr/pubspec.yaml (1)
14-14: Same pub.dev availability caveat applies here.
See comment inspeech-enhancement-gtcrn/pubspec.yaml.
🧹 Nitpick comments (5)
nodejs-examples/package.json (1)
1-6: JS example dependency updated – verify lockfile regenerationThe semver caret upgrade to
^1.12.5is fine.
Don’t forget to regeneratepackage-lock.json/pnpm-lock.yaml(if committed) so CI picks up the correct version.dart-api-examples/keyword-spotter/pubspec.yaml (1)
11-13: Version bump is correct – verify local path override is still commented out.No issues with the change itself, but if you ever need to switch back to the local path override (lines 13-14), remember to keep the version in
pubspec.yamland the local package’spubspec.yamlaligned to avoid Pub complaining about mismatched versions.jitpack.yml (1)
5-10: Consider de-duplicating the hard-coded version string.The AAR file name and the Maven install command both embed
1.12.5. On every release, two separate edits are required here. To avoid misses, you could parameterise the version via an environment variable:-before_install: - - wget https://github.com/k2-fsa/sherpa-onnx/releases/download/v1.12.5/sherpa-onnx-1.12.5.aar - -install: - - FILE="-Dfile=sherpa-onnx-1.12.5.aar" - - mvn install:install-file $FILE -DgroupId=com.k2fsa.sherpa.onnx -DartifactId=sherpa-onnx -Dversion=1.12.5 -Dpackaging=aar -DgeneratePom=true +env: + SHERPA_VERSION: 1.12.5 + +before_install: + - wget https://github.com/k2-fsa/sherpa-onnx/releases/download/v${SHERPA_VERSION}/sherpa-onnx-${SHERPA_VERSION}.aar + +install: + - FILE="-Dfile=sherpa-onnx-${SHERPA_VERSION}.aar" + - mvn install:install-file $FILE -DgroupId=com.k2fsa.sherpa.onnx -DartifactId=sherpa-onnx -Dversion=${SHERPA_VERSION} -Dpackaging=aar -DgeneratePom=trueThis reduces future maintenance overhead and lowers the risk of version skew.
build-ios-shared.sh (1)
244-246: Hard-coding the version string hurts maintainability.
CFBundleShortVersionStringis manually set to1.12.5, while the script
already knows$new_version. Consider templating to reduce future churn.- <key>CFBundleShortVersionString</key> - <string>1.12.5</string> + <key>CFBundleShortVersionString</key> + <string>${new_version}</string>(A simple
sedor heredoc variable expansion is enough.)android/SherpaOnnxAar/README.md (1)
3-20: Specify the shell language for the fenced code block.Markdown-lint flags
MD040because ``````` has no language hint.
Addbashfor proper syntax highlighting and to silence the linter.-``` +```bash
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
CHANGELOG.md(1 hunks)CMakeLists.txt(1 hunks)android/SherpaOnnxAar/README.md(2 hunks)android/SherpaOnnxJavaDemo/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(1 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)sherpa-onnx/csrc/version.cc(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
mfc-examples/README.md
9-9: Bare URL used
(MD034, no-bare-urls)
android/SherpaOnnxAar/README.md
19-19: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (22)
harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5 (1)
8-10: Confirmsherpa_onnx@1.12.5is published & no stale1.12.4references
- ✅ No
"1.12.4"literals found in any JSON/JSON5/YAML/Gradle/XML files.- Please verify that
sherpa_onnxv1.12.5 is live in the OpenHarmony registry before runningohpm installin CI.dart-api-examples/non-streaming-asr/pubspec.yaml (1)
12-14: ✅ No stale1.12.4references found – dependency bump to^1.12.5approvedThe update to
sherpa_onnx: ^1.12.5is consistent with the release target, and a search across allpubspec.yamlfiles confirmed no remaining1.12.4constraints.harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5 (1)
1-4: Package version updated – validate downstream bundlesNothing else changed in the manifest.
Confirm that all HarmonyOS sub-packages (SpeakerDiarization, StreamingAsr, Tts, etc.) now depend on1.12.5to avoid mixed-version installs.harmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5 (1)
8-10: Dependency bump acknowledgedSpeaker-diarization entry now targets
1.12.5; aligns with the umbrella release.harmony-os/SherpaOnnxHar/sherpa_onnx/README.md (1)
26-26: Version string correctly updated—no further action needed.
The documentation now points to1.12.5, keeping it in sync with the release train.android/SherpaOnnxJavaDemo/app/build.gradle (1)
37-37: Double-check JitPack availability ofv1.12.5.
JitPack requires the exact Git tag (v1.12.5) to exist and build successfully. Make sure the tag has been pushed and the build passes to avoid runtime 404s during Gradle resolution.dart-api-examples/speech-enhancement-gtcrn/pubspec.yaml (1)
13-13: Dependency bump looks good; verify pub.dev publication.
Confirm thatsherpa_onnx 1.12.5is already published on pub.dev before merging to prevent CI breakage for examples.harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets (1)
4-4: HAR version constant updated—looks correct.
No functional impact; aligns with the global version bump.dart-api-examples/vad/pubspec.yaml (1)
11-13: Dependency constraint looks good – confirm transitive consistency.The caret spec
^1.12.5will accept any future1.12.xrelease, which is what we want.
Just double-check that there are no lingering^1.12.4constraints in other Dart/Flutter packages that could force Pub to pick the lower version and produce a version-solver conflict.dart-api-examples/speaker-diarization/pubspec.yaml (1)
10-12: Consistent dependency update – LGTM.Everything is in sync here. Nothing else to flag.
harmony-os/SherpaOnnxVadAsr/entry/README.md (1)
3-3: README reflects the new artifact name – ensure the file actually exists.Small doc tweak looks fine. Please make sure
sherpa_onnx-v1.12.5.harhas already been uploaded to the referenced HuggingFace repo; the broken link risk is easy to miss during a version bump.flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec (1)
9-11: Podspec version updated – remember to tag & push CocoaPods trunk.Podspec change is correct. After the merge, don’t forget:
git tag v1.12.5(if you tag pods by version)pod trunk push ios/sherpa_onnx_ios.podspecSkipping either step will prevent consumers from fetching the new version.
flutter-examples/tts/pubspec.yaml (1)
8-9: Version bump looks correct and consistent.The
package.versionand thesherpa_onnxdependency were both bumped to1.12.5, matching the release objective. No other metadata is affected.Also applies to: 21-22
flutter-examples/streaming_asr/pubspec.yaml (1)
8-9: Consistent update to 1.12.5 – LGTM.Both the example’s own version and its
sherpa_onnxdependency now point at1.12.5, keeping the tree in sync.Also applies to: 34-35
pom.xml (1)
7-8: Artifact version aligned with release tag.
<version>1.12.5</version>correctly reflects the new release. Nothing else to flag.flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec (1)
7-8: Podspec version updated – OK.The podspec now advertises
1.12.5, matching other platform packages.new-release.sh (1)
4-6: Version-bump looks correct.
old_version/new_versionvalues and the sed replacement string are updated consistently.
No further action required for this hunk.mfc-examples/README.md (1)
8-10: Links updated correctly.All download URLs now point to
v1.12.5; table formatting and anchors remain intact.flutter/sherpa_onnx/pubspec.yaml (1)
19-49: Consistent version bump across package and sub-plugins.
version:and all platform-specific dependencies were bumped to 1.12.5 in one
go — nice job keeping them aligned.sherpa-onnx/csrc/version.cc (2)
9-22: Version metadata updated correctlyDate, SHA-1, and version string are all bumped to 1.12.5 and remain in the same immutable-string pattern used elsewhere in the project. No other logic changes introduced.
9-22: Double-check header consistency
version.hfrequently duplicates these constants for inline usage; make sure its literals were updated in the same commit so that downstream consumers don’t report mixed versions at runtime.CHANGELOG.md (1)
1-19: Changelog entry looks goodNew 1.12.5 section is present at the top and follows the existing bullet-style convention. All referenced PR numbers are intact.
1 participant
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Refactor
Chores