Skip to content

VoiceStudio is the open-source, fully-local ElevenLabs alternative — voice cloning, voice design, video dubbing, dictation, transcription & audiobook creation in 646 languages.

Merge main into feat/mobile-on-device

debpalash9280ec51111c
diff --cc .github/workflows/mobile-release.yml
index 46d35ac13,000000000..64532363d
mode 100644,000000..100644
--- a/.github/workflows/mobile-release.yml
+++ b/.github/workflows/mobile-release.yml
@@@ -1,284 -1,0 +1,249 @@@
- # Mobile release — signed Android APK/AAB and iOS IPA, uploaded to the Play
- # internal track and TestFlight. Promotion to production is a manual step in
- # each store console. The app version is the root package.json version; each
- # run's number is the store build number (VS_BUILD_NUMBER). Secrets live in the
- # protected `mobile-release` environment; see docs/mobile.md → Releasing.
- # A `mobile-v*` tag also collects every binary into a DRAFT GitHub prerelease
- # (signed APK + AAB, signed IPA, unsigned IPA for sideloading) for the owner to
- # review and publish, like the desktop release.
++# Mobile release — builds the signed Android APK/AAB and iOS IPA and gathers
++# them, with an unsigned IPA for sideloading, into a DRAFT GitHub prerelease for
++# the owner to review and publish. Store uploads stay in android-play-internal.yml
++# and ios-testflight.yml. The app version is the root package.json version; each
++# run's number is the build number. Secrets live in the protected
++# `mobile-release` environment; see docs/mobile.md → Releasing.
+
+name: mobile-release
+
+on:
+ workflow_dispatch:
+ inputs:
+ android:
+ description: Build Android
+ type: boolean
+ default: true
+ ios:
+ description: Build iOS
+ type: boolean
+ default: true
- upload:
- description: Upload to Play internal and TestFlight (off = signed artifacts only)
- type: boolean
- default: false
+ push:
+ tags: ["mobile-v*"]
+
+permissions:
+ contents: read
+
+concurrency:
+ group: mobile-release
+ cancel-in-progress: false
+
- env:
- VS_BUILD_NUMBER: ${{ github.run_number }}
-
+jobs:
+ android:
+ if: github.event_name == 'push' || inputs.android
+ runs-on: ubuntu-24.04
+ timeout-minutes: 60
+ environment: mobile-release
+ defaults:
+ run:
+ working-directory: mobile/android
+ steps:
+ - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+ with:
+ persist-credentials: false
+
+ - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
+ with:
+ distribution: temurin
+ java-version: "21"
+
+ - uses: gradle/actions/setup-gradle@42ebad84b0585498c0413b0967cf4e80ec0e1d19 # v4.4.1
+
+ - name: SDK location
+ run: printf 'sdk.dir=%s\n' "$ANDROID_HOME" > local.properties
+
+ - name: NDK and CMake
+ run: yes | "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" "ndk;27.1.12297006" "cmake;3.22.1" > /dev/null
+
+ - name: Cache native runtimes
+ uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+ with:
+ path: mobile/native/android/build
+ key: android-native-${{ hashFiles('mobile/native/pins.json', 'mobile/native/android/**', '!mobile/native/android/build/**') }}
+
+ - name: Decode keystore
+ env:
- KEYSTORE_B64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
++ KEYSTORE: ${{ secrets.ANDROID_UPLOAD_KEYSTORE }}
+ run: |
- test -n "$KEYSTORE_B64" || { echo "::error::ANDROID_KEYSTORE_BASE64 is not set in the mobile-release environment"; exit 1; }
- echo "$KEYSTORE_B64" | base64 -d > "$RUNNER_TEMP/release.keystore"
++ test -n "$KEYSTORE" || { echo "::error::ANDROID_UPLOAD_KEYSTORE is not set in the mobile-release environment"; exit 1; }
++ umask 077
++ printf '%s' "$KEYSTORE" | base64 --decode > "$RUNNER_TEMP/release.keystore"
+
+ - name: Build signed APK and AAB
+ env:
- VS_ANDROID_KEYSTORE: ${{ runner.temp }}/release.keystore
- VS_ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
- VS_ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
- VS_ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_KEY_PASSWORD }}
- run: ./gradlew --no-daemon :app:assembleRelease :app:bundleRelease
++ VOICESTUDIO_ANDROID_KEYSTORE: ${{ runner.temp }}/release.keystore
++ VOICESTUDIO_ANDROID_KEYSTORE_PASSWORD: ${{ secrets.ANDROID_UPLOAD_KEYSTORE_PASSWORD }}
++ VOICESTUDIO_ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_UPLOAD_KEY_ALIAS }}
++ VOICESTUDIO_ANDROID_KEY_PASSWORD: ${{ secrets.ANDROID_UPLOAD_KEY_PASSWORD }}
++ run: |
++ # Unique and increasing per run, including reruns.
++ export VOICESTUDIO_ANDROID_VERSION_CODE=$(( GITHUB_RUN_NUMBER * 10 + GITHUB_RUN_ATTEMPT ))
++ ./gradlew --no-daemon :app:assembleRelease :app:bundleRelease
+
+ - name: Collect outputs
+ run: |
+ mkdir -p "$RUNNER_TEMP/out"
+ cp app/build/outputs/apk/release/*.apk "$RUNNER_TEMP/out/VoiceStudio.apk"
+ cp app/build/outputs/bundle/release/*.aab "$RUNNER_TEMP/out/VoiceStudio.aab"
+
+ - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+ with:
+ name: VoiceStudio-android-release
+ path: ${{ runner.temp }}/out
+ retention-days: 30
+
- - name: Upload to Play internal track
- if: github.event_name == 'push' || inputs.upload
- uses: r0adkll/upload-google-play@935ef9c68bb393a8e6116b1575626a7f5be3a7fb # v1.1.3
- with:
- serviceAccountJsonPlainText: ${{ secrets.PLAY_SERVICE_ACCOUNT_JSON }}
- packageName: com.voicestudio.mobile
- releaseFiles: ${{ runner.temp }}/out/VoiceStudio.aab
- track: internal
- status: completed
-
+ - name: Remove keystore
+ if: always()
+ run: rm -f "$RUNNER_TEMP/release.keystore"
+
+ ios:
+ if: github.event_name == 'push' || inputs.ios
+ runs-on: macos-15
+ timeout-minutes: 80
+ environment: mobile-release
+ steps:
+ - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+ with:
+ persist-credentials: false
+
+ - name: Cache native runtimes
+ uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+ with:
+ path: mobile/native/ios/build
+ key: ios-native-${{ hashFiles('mobile/native/pins.json', 'mobile/native/ios/**', '!mobile/native/ios/build/**') }}
+
+ - name: Build native runtimes
+ env:
+ GITHUB_TOKEN: ${{ github.token }}
+ run: |
+ brew install cmake ninja 2>/dev/null || true
+ bash mobile/native/ios/build.sh ios
+
+ - name: Generate Xcode project
+ run: |
+ brew install xcodegen
+ xcodegen generate --spec mobile/ios/VoiceStudio/project.yml
+
- # A temporary keychain holds the distribution certificate; removed at the end.
- - name: Install certificate and profile
++ - name: Write App Store Connect API key
+ env:
- CERT_B64: ${{ secrets.IOS_CERT_P12_BASE64 }}
- CERT_PASSWORD: ${{ secrets.IOS_CERT_PASSWORD }}
- PROFILE_B64: ${{ secrets.IOS_PROFILE_BASE64 }}
++ ASC_KEY: ${{ secrets.APP_STORE_CONNECT_API_KEY }}
+ run: |
- test -n "$CERT_B64" && test -n "$PROFILE_B64" || { echo "::error::iOS signing secrets are not set in the mobile-release environment"; exit 1; }
- KEYCHAIN="$RUNNER_TEMP/release.keychain-db"
- KEYCHAIN_PASSWORD="$(uuidgen)"
- security create-keychain -p "$KEYCHAIN_PASSWORD" "$KEYCHAIN"
- security set-keychain-settings -lut 21600 "$KEYCHAIN"
- security unlock-keychain -p "$KEYCHAIN_PASSWORD" "$KEYCHAIN"
- echo "$CERT_B64" | base64 -d > "$RUNNER_TEMP/cert.p12"
- security import "$RUNNER_TEMP/cert.p12" -P "$CERT_PASSWORD" -A -t cert -f pkcs12 -k "$KEYCHAIN"
- security set-key-partition-list -S apple-tool:,apple: -k "$KEYCHAIN_PASSWORD" "$KEYCHAIN" > /dev/null
- security list-keychains -d user -s "$KEYCHAIN" login.keychain
- echo "$PROFILE_B64" | base64 -d > "$RUNNER_TEMP/profile.mobileprovision"
- security cms -D -i "$RUNNER_TEMP/profile.mobileprovision" > "$RUNNER_TEMP/profile.plist"
- PROFILE_UUID=$(/usr/libexec/PlistBuddy -c "Print :UUID" "$RUNNER_TEMP/profile.plist")
- PROFILE_NAME=$(/usr/libexec/PlistBuddy -c "Print :Name" "$RUNNER_TEMP/profile.plist")
- mkdir -p "$HOME/Library/MobileDevice/Provisioning Profiles"
- cp "$RUNNER_TEMP/profile.mobileprovision" "$HOME/Library/MobileDevice/Provisioning Profiles/$PROFILE_UUID.mobileprovision"
- echo "PROFILE_NAME=$PROFILE_NAME" >> "$GITHUB_ENV"
++ test -n "$ASC_KEY" || { echo "::error::APP_STORE_CONNECT_API_KEY is not set in the mobile-release environment"; exit 1; }
++ umask 077
++ printf '%s\n' "$ASC_KEY" > "$RUNNER_TEMP/asc_api_key.p8"
+
++ # Automatic signing with the API key creates the cloud-managed Apple
++ # Distribution certificate and App Store profile; no .p12 is stored.
+ - name: Archive
+ env:
- TEAM_ID: ${{ secrets.IOS_TEAM_ID }}
++ ASC_KEY_ID: ${{ secrets.APP_STORE_CONNECT_KEY_ID }}
++ ASC_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_ISSUER_ID }}
++ TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
++ VOICESTUDIO_IOS_BUILD_NUMBER: ${{ github.run_number }}.${{ github.run_attempt }}
+ run: |
- xcodebuild archive \
- -project mobile/ios/VoiceStudio/VoiceStudio.xcodeproj \
- -scheme VoiceStudio -configuration Release -destination 'generic/platform=iOS' \
++ xcodebuild -project mobile/ios/VoiceStudio/VoiceStudio.xcodeproj \
++ -scheme VoiceStudio -configuration Release \
++ -destination 'generic/platform=iOS' \
+ -archivePath "$RUNNER_TEMP/VoiceStudio.xcarchive" \
- CODE_SIGN_STYLE=Manual CODE_SIGN_IDENTITY="Apple Distribution" \
- DEVELOPMENT_TEAM="$TEAM_ID" PROVISIONING_PROFILE_SPECIFIER="$PROFILE_NAME"
++ -allowProvisioningUpdates \
++ -authenticationKeyPath "$RUNNER_TEMP/asc_api_key.p8" \
++ -authenticationKeyID "$ASC_KEY_ID" \
++ -authenticationKeyIssuerID "$ASC_ISSUER_ID" \
++ DEVELOPMENT_TEAM="$TEAM_ID" CODE_SIGN_STYLE=Automatic \
++ archive
+
+ - name: Export IPA
+ env:
- TEAM_ID: ${{ secrets.IOS_TEAM_ID }}
++ ASC_KEY_ID: ${{ secrets.APP_STORE_CONNECT_KEY_ID }}
++ ASC_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_ISSUER_ID }}
++ TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
+ run: |
- cat > "$RUNNER_TEMP/ExportOptions.plist" <<PLIST
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
- <plist version="1.0"><dict>
- <key>method</key><string>app-store-connect</string>
- <key>teamID</key><string>$TEAM_ID</string>
- <key>signingStyle</key><string>manual</string>
- <key>provisioningProfiles</key><dict><key>com.voicestudio.mobile</key><string>$PROFILE_NAME</string></dict>
- </dict></plist>
- PLIST
- xcodebuild -exportArchive -archivePath "$RUNNER_TEMP/VoiceStudio.xcarchive" \
- -exportOptionsPlist "$RUNNER_TEMP/ExportOptions.plist" -exportPath "$RUNNER_TEMP/ipa"
++ /usr/libexec/PlistBuddy -c 'Add :method string app-store-connect' \
++ -c 'Add :destination string export' \
++ -c "Add :teamID string $TEAM_ID" \
++ -c 'Add :signingStyle string automatic' \
++ "$RUNNER_TEMP/ExportOptions.plist"
++ xcodebuild -exportArchive \
++ -archivePath "$RUNNER_TEMP/VoiceStudio.xcarchive" \
++ -exportOptionsPlist "$RUNNER_TEMP/ExportOptions.plist" \
++ -exportPath "$RUNNER_TEMP/ipa" \
++ -allowProvisioningUpdates \
++ -authenticationKeyPath "$RUNNER_TEMP/asc_api_key.p8" \
++ -authenticationKeyID "$ASC_KEY_ID" \
++ -authenticationKeyIssuerID "$ASC_ISSUER_ID"
+ ls "$RUNNER_TEMP/ipa"/*.ipa
+
+ - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+ with:
+ name: VoiceStudio-ios-release
+ path: ${{ runner.temp }}/ipa/*.ipa
+ retention-days: 30
+
+ # Unsigned device build for people who sideload with their own Apple ID
+ # (the store IPA above is signed for App Store Connect and will not install
+ # outside TestFlight).
+ - name: Unsigned iPhone build for sideloading
+ run: |
+ xcodebuild -project mobile/ios/VoiceStudio/VoiceStudio.xcodeproj \
+ -scheme VoiceStudio -configuration Release -sdk iphoneos \
+ -destination 'generic/platform=iOS' -derivedDataPath "$RUNNER_TEMP/device" \
+ CODE_SIGNING_ALLOWED=NO CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY="" build
+ mkdir -p "$RUNNER_TEMP/unsigned/Payload"
+ cp -R "$RUNNER_TEMP/device/Build/Products/Release-iphoneos/VoiceStudio.app" "$RUNNER_TEMP/unsigned/Payload/"
+ (cd "$RUNNER_TEMP/unsigned" && zip -qry "$RUNNER_TEMP/VoiceStudio-unsigned.ipa" Payload)
+
+ - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+ with:
+ name: VoiceStudio-ios-unsigned
+ path: ${{ runner.temp }}/VoiceStudio-unsigned.ipa
+ retention-days: 30
+
- - name: Upload to TestFlight
- if: github.event_name == 'push' || inputs.upload
- env:
- ASC_KEY_ID: ${{ secrets.ASC_KEY_ID }}
- ASC_ISSUER_ID: ${{ secrets.ASC_ISSUER_ID }}
- ASC_KEY_P8: ${{ secrets.ASC_KEY_P8 }}
- run: |
- mkdir -p "$HOME/.appstoreconnect/private_keys"
- printf '%s' "$ASC_KEY_P8" > "$HOME/.appstoreconnect/private_keys/AuthKey_${ASC_KEY_ID}.p8"
- xcrun altool --upload-app --type ios --file "$RUNNER_TEMP"/ipa/*.ipa \
- --apiKey "$ASC_KEY_ID" --apiIssuer "$ASC_ISSUER_ID"
-
- - name: Remove signing material
++ - name: Remove API key
+ if: always()
- run: |
- security delete-keychain "$RUNNER_TEMP/release.keychain-db" || true
- rm -f "$RUNNER_TEMP/cert.p12" "$HOME/.appstoreconnect/private_keys/"*.p8
- rm -rf "$HOME/Library/MobileDevice/Provisioning Profiles"
++ run: rm -f "$RUNNER_TEMP/asc_api_key.p8"
+
+ # Tag builds gather every binary into a draft prerelease; nothing is public until
+ # the owner publishes it. Skipped for manual runs, which only produce artifacts.
+ release:
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/mobile-v')
+ needs: [android, ios]
+ runs-on: ubuntu-24.04
+ timeout-minutes: 15
+ permissions:
+ contents: write
+ steps:
+ - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+ with:
+ path: assets
+
+ - name: Draft prerelease
+ env:
+ GH_TOKEN: ${{ github.token }}
+ TAG: ${{ github.ref_name }}
+ REPO: ${{ github.repository }}
+ run: |
+ set -eu
+ mkdir -p out
+ cp assets/VoiceStudio-android-release/VoiceStudio.apk "out/VoiceStudio-${TAG}.apk"
+ cp assets/VoiceStudio-android-release/VoiceStudio.aab "out/VoiceStudio-${TAG}.aab"
+ cp assets/VoiceStudio-ios-release/*.ipa "out/VoiceStudio-${TAG}-appstore.ipa"
+ cp assets/VoiceStudio-ios-unsigned/VoiceStudio-unsigned.ipa "out/VoiceStudio-${TAG}-unsigned.ipa"
+ (cd out && sha256sum * > SHA256SUMS.txt)
+ cat > notes.md <<NOTES
+ VoiceStudio phone apps ${TAG}. Preview builds; they run models on the phone.
+
+ | File | Use |
+ |---|---|
+ | \`VoiceStudio-${TAG}.apk\` | Android: install directly (allow installs from this source) |
+ | \`VoiceStudio-${TAG}.aab\` | Android App Bundle for Google Play |
+ | \`VoiceStudio-${TAG}-unsigned.ipa\` | iPhone: sideload with your own Apple ID (for example Sideloadly) |
+ | \`VoiceStudio-${TAG}-appstore.ipa\` | App Store Connect build; it only installs through TestFlight |
+
+ Verify downloads against \`SHA256SUMS.txt\`. Details: docs/mobile.md.
+ NOTES
+ if gh release view "$TAG" --repo "$REPO" >/dev/null 2>&1; then
+ test "$(gh release view "$TAG" --repo "$REPO" --json isDraft --jq .isDraft)" = true || { echo "Refusing to replace a published release"; exit 1; }
+ gh release upload "$TAG" out/* --repo "$REPO" --clobber
+ else
+ gh release create "$TAG" out/* --repo "$REPO" --verify-tag --draft --prerelease --title "$TAG — VoiceStudio mobile" --notes-file notes.md
+ fi
diff --cc CHANGELOG.md
index 928008999,8b7cae6e7..853c3799a
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@@ -15,9 -15,72 +15,77 @@@ metadata and the backend fallback mirro
### Changed
+- Small models now install with as little as 2 GB spare disk; the setup check only warns below 10 GB instead of blocking (#2969)
+- iOS Home shows Electron's contributor avatars, Dub is redesigned around one source card with animated icons, and the iOS bottom dock is icon-only (#2969)
+- Model licence review on iOS and Android opens with a plain summary, rights rows and licence links; the raw terms move under Exact terms (#2969)
+ - Phone apps now use the app ID `sh.voicestudio.mobile`; a preview build installed before installs alongside as a new app, so pair it again and remove the old one (#3194)
+
+ ### Added
+
+ - Beta update channel: choose Stable or Beta under Settings → Updates; betas are `-beta.N` prereleases that never reach Stable users, and Docker gets matching `:beta` tags ([guide](docs/update-channels.md)) (#3175)
+
+ - Preview iOS and Android companion apps: drive your own VoiceStudio from your phone (speak, voices and cloning, dubbing, dictation) after pairing by QR code; build from source for now ([guide](docs/mobile.md)) (#2965)
+ - Smart Fit speed limits: set the fastest and slowest speed dubbing may apply to a line, from the Timing section (#3026) — thanks @MoonDragon-MD!
+
+ ### Fixed
+
+ - Bug reports no longer risk freezing the app while looking for your tools: the Node-version folder scan now runs off the main thread (#3180)
+ - Bug reports no longer freeze the app when the tool search or a drive stalls, and free disk is only borrowed from a parent folder when the install folder doesn't exist yet (#3179)
+ - Model licence dialog is wider and scrolls as one area with the buttons pinned, and follows macOS, Windows and Linux dialog conventions (#3160)
+ - Bug reports now include your OS, memory, free disk and whether the Python runtime exists, even when the backend never started, plus flags for risky install paths such as OneDrive or non-ASCII folders (#3156)
+ - Bug reports no longer hang on a stalled drive, and report free disk and the uv tool correctly on first run and in source checkouts (#3170)
+ - Older synthesized takes play again with accurate play/pause controls after a newer generation (#3102)
+ - Generation-complete notifications appear above the workspace instead of covering synthesis controls (#3102)
+ - Generated speech no longer starts and ends with silence, and `[pause]` markers give exactly the pause you asked for (Raw preset and explicit durations untouched) (#3080)
+ - Engine sidecars no longer load PyTorch just to answer the Test Engine ping, and a failed test logs its reason locally (#3026) — thanks @tekay-de!
+
+ ### Fixed
+
+ - Windows runtime refresh no longer fails with `EPERM` on a locked backend folder (OneDrive, antivirus): it updates the files in place; the missing-Python-environment message now names the exact folder and tells non-checkout installs to use the installer (#3023) — thanks @afraniohugo, @javalovelinux-cmd and @eduardpp00!
+
+ ### Fixed
+
+ - The install location chosen in first-run setup now also holds your data, model cache and temp files instead of quietly filling `C:`, and the setup screen shows each path (#2971, #3035)
+ - Supertonic-3's preset voices can be picked in the voice controls and are used for generation (#2938, #3035)
+
+ - `OMNIVOICE_ENGINES_DIR` moves engine venvs and the audio.cpp runtime to another drive; the default location is unchanged (#3024)
+
+ ### Fixed
+
+ - The installed app now rebuilds a Python environment that antivirus or disk cleanup removed, once per launch with the usual setup progress, instead of stopping at a setup error; your voices and projects are untouched (#3032) — thanks @afraniohugo and @javalovelinux-cmd!
+
+ ### Docs
+
+ - `SPONSORS.md` now states what each sponsorship tier gives, when recognition starts, and what sponsorship does not buy, and the README and inquiry form point to it (#3172)
+ - OmniVoice GGUF docs state that the installers do not ship its native binary yet (#3026) — thanks @DestinyQJY!
+ - Contributor guides and the pull request template explain how to sign the CLA before opening a first pull request (#2676)
+
+ ### Fixed
+
+ - macOS builds without a Developer ID are now signed ad hoc so the bundle signature is valid, and the shell installer clears quarantine, repairs an invalid signature of older releases, names an unreadable disk image, and tells Intel Mac users the backend needs Apple Silicon (#3033, #2763, #2829, #2681)
+ - A "Generation failed" log line now says where it was raised and which error caused it, and the out-of-memory advice mentions picking another GPU, so these reports can be told apart (#2895, #2684, #2666, #2626, #2622, #2580, #3034)
+
+ ### CI
+
++- New `mobile-release` workflow builds signed Android and iOS apps and drafts a GitHub prerelease with the APK, AAB and IPAs (#2969)
++- The `mobile` workflow builds the pinned on-device runtimes for both apps (#2969)
+ - Interactive release helper: pick stable or beta, draft or publish, and confirm by typing the tag (`scripts/release.py`) (#3187)
+ - Release helper choices are arrow-key menus (#3190)
+ - Desktop request-guard self-tests stay deterministic when app requests arrive during cleanup (#2676)
+
+ - New `mobile` workflow builds and tests both phone apps; a contract test fails when their theme or API description drifts from the desktop app (#2965)
+
+ - iOS TestFlight workflow: maintainers can upload a signed iPhone build for internal testers from `main` ([guide](docs/mobile.md#testflight-maintainers)) (#3188)
+ - Android Play internal testing workflow: the matching signed Android upload from `main`, and beta versions no longer break the Android build ([guide](docs/mobile.md#play-internal-testing-maintainers)) (#3189)
+
+ - Gallery preview fallback smoke no longer flakes when a slower runner reads the playing clip in several byte ranges (#3018)
+
+ ## [0.5.7-beta.1] — 2026-10-23
+
+ **Highlights**
+
+ - Preview iOS and Android companion apps for your own VoiceStudio
+ - Opt-in Beta update channel: get fixes early from Settings → Updates, and roll onto the next stable release automatically
### Added
@@@ -73,12 -129,15 +141,17 @@@
### CI
- - New `mobile-release` workflow builds signed Android and iOS apps and drafts a GitHub prerelease with the APK, AAB and IPAs, with optional Play internal and TestFlight uploads (#2969)
+ - Interactive release helper: pick stable or beta, draft or publish, and confirm by typing the tag (`scripts/release.py`) (#3187)
+ - Release helper choices are arrow-key menus (#3190)
++- New `mobile-release` workflow builds signed Android and iOS apps and drafts a GitHub prerelease with the APK, AAB and IPAs, (#2969)
- Desktop request-guard self-tests stay deterministic when app requests arrive during cleanup (#2676)
- New `mobile` workflow builds and tests both phone apps; a contract test fails when their theme or API description drifts from the desktop app (#2965)
+- The `mobile` workflow builds the pinned on-device runtimes for both apps (#2969)
+ - iOS TestFlight workflow: maintainers can upload a signed iPhone build for internal testers from `main` ([guide](docs/mobile.md#testflight-maintainers)) (#3188)
+ - Android Play internal testing workflow: the matching signed Android upload from `main`, and beta versions no longer break the Android build ([guide](docs/mobile.md#play-internal-testing-maintainers)) (#3189)
+
- Gallery preview fallback smoke no longer flakes when a slower runner reads the playing clip in several byte ranges (#3018)
## [0.5.7] — 2026-10-17
diff --cc docs/RELEASING.md
index 8284d0e82,f644038cb..3b2af6047
--- a/docs/RELEASING.md
+++ b/docs/RELEASING.md
@@@ -160,14 -169,32 +169,40 @@@ the opt-in **Beta** channel (below). Pr
`main` (the `electron-build.yml` artifacts or Docker `:latest`), never a side
branch. No Tauri build is maintained.
+ ## Release helper
+
+ `make release` (or `uv run python scripts/release.py`) cuts a release from any
+ branch. It shows the last release and the version on `main`, then asks **stable
+ or beta** and suggests the new tag (`v0.5.7`, or `v0.5.7-beta.1`, `-beta.2`, ...
+ for a beta; the beta suffix is always `-beta.N`). If `package.json` already names
+ the upcoming release it uses that version; if that version is already tagged it
+ moves to the next patch. Choices are arrow-key menus (up/down or `j`/`k`,
+ Enter; Esc cancels) that fall back to typed answers when there is no terminal.
+ It then asks **draft or publish**, prints the plan
+ (including switching to `main` and fast-forwarding it), and only proceeds when you
+ type the tag name.
+
+ - **Draft:** bumps the three version files in lockstep, runs `uv lock`, writes
+ the `CHANGELOG.md` section from `[Unreleased]` (a stable release renames it; a
+ beta copies it), runs the version guards, commits, pushes `main` and the tag.
+ The tag push builds a draft release; nothing is public.
+ - **Publish:** the same, then dispatches `electron-release.yml` with
+ `publish=true`. If the Mac/Windows signing secrets are missing or unreadable it
+ stops unless you explicitly accept unsigned installers.
+ - `--publish vX.Y.Z[-beta.N]` (`make release-publish TAG=…`) publishes an existing
+ draft build later.
+ - `--dry-run` (`make release-dry`) prints the plan and changes nothing.
+
+ It does not replace the post-release verification below; run it every time.
+
+## Mobile apps
+
+Phone apps ship on their own `mobile-v*` tags through the `mobile-release`
- workflow (Play internal track, TestFlight and a draft GitHub prerelease with the
- APK, AAB and IPAs). The version is the root `package.json` version and each run's
++workflow (a draft GitHub prerelease with the APK, AAB and IPAs; store uploads use
++the TestFlight and Play internal workflows). The version is the root `package.json` version and each run's
+number is the store build number. Setup, secrets and sideloading: `docs/mobile.md`
+→ Releasing. Publishing the draft and promoting the store builds are manual.
+
## Beta channel
Beta is a second release channel cut from `main`, for testers who opt in under
diff --cc docs/mobile.md
index e3a478d8f,56909753d..7f1c75595
--- a/docs/mobile.md
+++ b/docs/mobile.md
@@@ -92,27 -76,49 +92,73 @@@ Security) when iOS asks. App text uses
Electron locale catalogs (`mobile.*` keys). The `mobile` workflow builds and
tests both apps.
+ ## TestFlight (maintainers)
+
+ The `iOS TestFlight` workflow signs the iPhone app and uploads it to TestFlight
+ for the team's internal testers. It is dispatched by hand from `main` and never
+ submits the app for App Store review. One-time setup in the Apple Developer team:
+
+ 1. Register the App ID `sh.voicestudio.mobile` (Certificates, Identifiers &
+ Profiles → Identifiers) and create the app in App Store Connect with it.
+ 2. Create an App Store Connect API key with the **Admin** role (Users and
+ Access → Integrations). Admin lets CI create the cloud-managed Apple
+ Distribution certificate and App Store profile, so no `.p12` is stored.
+ 3. Create the `app-store-connect` environment (Settings → Environments), limit
+ it to the `main` branch, and add `APP_STORE_CONNECT_KEY_ID`,
+ `APP_STORE_CONNECT_ISSUER_ID` and `APP_STORE_CONNECT_API_KEY` (the full
+ `.p8` text). `APPLE_TEAM_ID` is shared with macOS notarization.
+
+ The version is the root `package.json` version without any `-beta.N` suffix
+ (App Store Connect accepts only `X.Y.Z`); the build number is the workflow run
+ number and attempt, so every upload is new.
+
+ ## Play internal testing (maintainers)
+
+ The `Android Play internal testing` workflow is the Android counterpart: it
+ signs a release bundle with the Play upload key and uploads it to the Play
+ Console **internal testing** track. It is dispatched by hand from `main` and
+ never sends a release to production. One-time setup:
+
+ 1. Create the app in the Play Console with the package name
+ `sh.voicestudio.mobile` and keep Play App Signing on (Google holds the app
+ signing key; CI only holds the upload key).
+ 2. Create an upload key once and keep a backup in the team password manager:
+ `keytool -genkeypair -v -keystore upload.jks -alias upload -keyalg RSA -keysize 4096 -validity 10000`.
+ 3. Create a Google Cloud service account with a JSON key, then invite its email
+ in the Play Console (Users and permissions) with release access to this app.
+ 4. Create the `google-play` environment (Settings → Environments), limit it to
+ the `main` branch, and add `ANDROID_UPLOAD_KEYSTORE` (the `.jks` as base64),
+ `ANDROID_UPLOAD_KEYSTORE_PASSWORD`, `ANDROID_UPLOAD_KEY_ALIAS`,
+ `ANDROID_UPLOAD_KEY_PASSWORD` and `GOOGLE_PLAY_SERVICE_ACCOUNT_JSON`.
+ 5. Google Play takes the first bundle only through the Play Console: run the
+ workflow once (its upload step fails), download the `VoiceStudio-android-play`
+ artifact and upload it to internal testing by hand. Until the app's first
+ release is rolled out, dispatch with status `draft`.
+
+ The version name is the root `package.json` version; the version code is the
+ workflow run number × 10 plus the attempt, so every upload is new. Local and
+ `mobile` workflow builds stay debug-signed.
++
+## Releasing
+
- The `mobile-release` workflow builds the signed Android APK/AAB and iOS IPA and,
- when asked, uploads them to the Play **internal** track and **TestFlight**. It
- never publishes to production; promote a build in each store console.
-
- - **Run it:** Actions → `mobile-release` → Run workflow (uploads are off by
- default, so you get signed artifacts to test), or push a `mobile-v*` tag
- (builds and uploads both).
- - **Downloads for everyone:** a `mobile-v*` tag also creates a **draft** GitHub
- prerelease with the signed APK and AAB, the App Store IPA, an unsigned IPA for
- sideloading, and `SHA256SUMS.txt`. Review it, then publish. The App Store IPA
- only installs through TestFlight; iPhone users outside TestFlight sideload the
- unsigned IPA with their own Apple ID.
- - **Version:** the root `package.json` version. Each run's number is the store
- build number, so a rebuild of the same version still uploads.
- - **Secrets** (repository environment `mobile-release`, with required reviewers):
- - Android: `ANDROID_KEYSTORE_BASE64`, `ANDROID_KEYSTORE_PASSWORD`,
- `ANDROID_KEY_ALIAS`, `ANDROID_KEY_PASSWORD`, `PLAY_SERVICE_ACCOUNT_JSON`
- - iOS: `IOS_CERT_P12_BASE64`, `IOS_CERT_PASSWORD`, `IOS_PROFILE_BASE64`
- (App Store distribution profile for `com.voicestudio.mobile`), `IOS_TEAM_ID`,
- `ASC_KEY_ID`, `ASC_ISSUER_ID`, `ASC_KEY_P8`
- - **First upload:** create the app records in Play Console and App Store Connect
- first; Play needs the first bundle uploaded once and the data-safety form filled.
++The `mobile-release` workflow builds the signed Android APK/AAB and iOS IPA and
++drafts a GitHub prerelease with them. Store uploads are separate: use
++[TestFlight](#testflight-maintainers) and
++[Play internal testing](#play-internal-testing-maintainers). Nothing is published
++to production automatically.
++
++- **Run it:** Actions → `mobile-release` → Run workflow (signed artifacts only),
++ or push a `mobile-v*` tag (also drafts the release).
++- **Downloads for everyone:** the draft prerelease holds the signed APK and AAB,
++ the App Store IPA, an unsigned IPA for sideloading, and `SHA256SUMS.txt`. Review
++ it, then publish. The App Store IPA only installs through TestFlight; iPhone
++ users outside TestFlight sideload the unsigned IPA with their own Apple ID.
++- **Version:** the root `package.json` version; each run's number makes the build
++ number, so a rebuild of the same version stays unique.
++- **Secrets** (repository environment `mobile-release`, with required reviewers,
++ not limited to `main` so tags can use it): the same values as the store
++ workflows, `ANDROID_UPLOAD_KEYSTORE`, `ANDROID_UPLOAD_KEYSTORE_PASSWORD`,
++ `ANDROID_UPLOAD_KEY_ALIAS`, `ANDROID_UPLOAD_KEY_PASSWORD`,
++ `APP_STORE_CONNECT_KEY_ID`, `APP_STORE_CONNECT_ISSUER_ID`,
++ `APP_STORE_CONNECT_API_KEY` and `APPLE_TEAM_ID`.
++
diff --cc mobile/android/README.md
index 36d7703b6,cf66d851e..15b27806f
--- a/mobile/android/README.md
+++ b/mobile/android/README.md
@@@ -26,11 -23,11 +26,13 @@@ printf 'sdk.dir=%s\n' "$ANDROID_HOME"
./gradlew testDebugUnitTest
./gradlew lint
./gradlew assembleDebugAndroidTest
+ ./gradlew installDebug
+ adb shell am start -n sh.voicestudio.mobile/com.voicestudio.mobile.MainActivity
```
-Windows: use `gradlew.bat` and equivalent JAVA_HOME / ANDROID_HOME settings.
+Windows: Gradle uses `gradlew.bat`; native preparation also needs Bash and
+Python 3, with equivalent JAVA_HOME / ANDROID_HOME settings. This host verifies
+the macOS build path.
`local.properties`, build outputs and local IDE state are ignored. Gradle 8.13,
AGP 8.12.0, Kotlin 2.2.21 and direct dependencies are pinned in the wrapper and
`gradle/libs.versions.toml`. The wrapper was generated using installed Gradle
diff --cc mobile/android/app/build.gradle.kts
index 0397cecb9,291aef6da..01ef80924
--- a/mobile/android/app/build.gradle.kts
+++ b/mobile/android/app/build.gradle.kts
@@@ -9,14 -17,12 +17,14 @@@ val uploadKeystore = providers.environm
android {
namespace = "com.voicestudio.mobile"
compileSdk = 36
+ ndkVersion = "27.1.12297006"
defaultConfig {
- applicationId = "com.voicestudio.mobile"
+ // Store identity (voicestudio.sh); the Kotlin namespace stays com.voicestudio.mobile.
+ applicationId = "sh.voicestudio.mobile"
minSdk = 29
+ ndk { abiFilters += listOf("arm64-v8a", "x86_64") }
targetSdk = 36
- // Play needs a unique, increasing code per upload: version * 1000 + CI build number.
- versionCode = appVersion.split(".").take(3).map { it.toInt() }.let { it[0]*1000000+it[1]*1000+it[2] } * 1000 + (System.getenv("VS_BUILD_NUMBER")?.toInt() ?: 0)
+ versionCode = appVersionCode
versionName = appVersion
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
}
@@@ -75,8 -69,8 +80,9 @@@ val bundleCatalogs by tasks.registerin
}
}
tasks.named("preBuild") { dependsOn(bundleCatalogs) }
+ tasks.register("printAppVersion") { doLast { println("versionName=$appVersion versionCode=$appVersionCode") } }
dependencies {
+ implementation(files(rootDir.resolve("../native/android/build/downloads/sherpa.aar")).builtBy(":core:local:fetchRuntimes"))
implementation(project(":features"))
implementation(libs.activity)
implementation(libs.lifecycle)
diff --cc mobile/ios/VoiceStudio/project.yml
index de1aeb444,dadbcf6cc..cf4e3b580
--- a/mobile/ios/VoiceStudio/project.yml
+++ b/mobile/ios/VoiceStudio/project.yml
@@@ -25,27 -24,13 +25,27 @@@ targets
- path: Features
- path: Platform
- path: Resources
+ - path: ../.generated/Brand.xcassets
settings:
base:
- PRODUCT_BUNDLE_IDENTIFIER: com.voicestudio.mobile
+ PRODUCT_BUNDLE_IDENTIFIER: sh.voicestudio.mobile
GENERATE_INFOPLIST_FILE: 'NO'
INFOPLIST_FILE: $(DERIVED_FILE_DIR)/VoiceStudio-Info.plist
+ ASSETCATALOG_COMPILER_APPICON_NAME: AppIcon
dependencies:
- package: VoiceStudioKit
+ - framework: ../../native/ios/build/xcframeworks/sherpa-onnx.xcframework
+ embed: false
+ - framework: ../../native/ios/build/xcframeworks/onnxruntime.xcframework
+ embed: false
+ - framework: ../../native/ios/build/xcframeworks/llama.xcframework
+ embed: true
+ - framework: ../../native/ios/build/xcframeworks/OmniVoice.xcframework
+ embed: true
+ - sdk: libc++.tbd
+ - sdk: Accelerate.framework
+ - sdk: Metal.framework
+ - sdk: MetalKit.framework
preBuildScripts:
- name: Bundle catalogs and derive version
script: |
diff --cc mobile/ios/scripts/prepare_resources.py
index 6fdbd52af,8d451953c..1c3508952
--- a/mobile/ios/scripts/prepare_resources.py
+++ b/mobile/ios/scripts/prepare_resources.py
@@@ -45,33 -27,23 +45,48 @@@ def lookup(catalog, key)
return value if isinstance(value, str) else None
+def validate_native_notices(directory, pins):
+ manifest = json.loads((directory / "sources.json").read_text())
+ expected = {"sherpa-onnx", "omnivoice.cpp", "omnivoice-ggml", "llama.cpp", "llama-ggml",
+ "espeak-ng-for-piper", "piper-phonemize", "kaldi-native-fbank", "kissfft",
+ "kaldi-decoder", "kaldifst", "openfst", "simple-sentencepiece", "json", "hclust-cpp", "eigen", "onnxruntime"}
+ if {entry["name"] for entry in manifest} != expected:
+ raise ValueError("Native licence set is incomplete; run mobile/native/ios/prepare-notices.py")
+ for entry in manifest:
+ text = (directory / (entry["name"] + ".txt")).read_bytes()
+ if hashlib.sha256(text).hexdigest() != entry["notice_sha256"]:
+ raise ValueError("Native licence changed: " + entry["name"])
+ if entry["name"] in pins:
+ pin = pins[entry["name"]]["source"]
+ if entry["source"] != pin["repo"] + "/tree/" + pin["commit"]:
+ raise ValueError("Native licence pin drift: " + entry["name"])
+ if not (directory / "Corresponding-source.txt").is_file():
+ raise ValueError("Missing GPL corresponding sources")
+
+
+ def marketing_version(version):
+ # App Store Connect accepts only X.Y.Z, so a beta uploads as its X.Y.Z under a new build number.
+ match = re.fullmatch(r"(\d+\.\d+\.\d+)(?:-beta\.\d+)?", version)
+ if not match:
+ raise ValueError(f"Unsupported app version for iOS: {version}")
+ return match.group(1)
+
+
+ def build_number(value):
+ # TestFlight needs a new, increasing build number per upload: up to three integers.
+ if not re.fullmatch(r"\d+(?:\.\d+){0,2}", value):
+ raise ValueError(f"Invalid iOS build number: {value}")
+ return value
+
+
def prepare(output, info):
output.mkdir(parents=True, exist_ok=True)
+ legal = IOS / "VoiceStudio/Resources/NativeLicences"
+ validate_native_notices(legal,json.loads((ROOT / "mobile/native/pins.json").read_text()))
+ shutil.copytree(legal,output / "NativeLicences",dirs_exist_ok=True)
+ notices = ROOT / "mobile/native/ios/build/xcframeworks/Notices"
+ if notices.is_dir():
+ shutil.copytree(notices, output / "NativeLicences", dirs_exist_ok=True)
catalogs = output / "Catalogs"
catalogs.mkdir(exist_ok=True)
source = ROOT / "electron/src/renderer/src/i18n/locales"
@@@ -107,12 -74,11 +122,11 @@@
(localized / "InfoPlist.strings").write_text("\n".join(lines) + "\n")
version = json.loads((ROOT / "package.json").read_text())["version"]
data = plistlib.loads((IOS / "VoiceStudio/Info.plist").read_bytes())
- data["CFBundleShortVersionString"] = version
- # Store uploads need a unique, increasing build per version (CI passes the run number).
- data["CFBundleVersion"] = os.environ.get("VS_BUILD_NUMBER", "1")
+ data["CFBundleShortVersionString"] = marketing_version(version)
+ data["CFBundleVersion"] = build_number(os.environ.get("VOICESTUDIO_IOS_BUILD_NUMBER", "1"))
data["CFBundleLocalizations"] = sorted(path.stem for path in source.glob("*.json"))
- for field, key in permissions.items():
- data[field] = lookup(english, key)
+ for field, keys in permissions.items():
+ data[field] = "\n".join(lookup(english, key) for key in keys)
info.parent.mkdir(parents=True, exist_ok=True)
info.write_bytes(plistlib.dumps(data))