[docs] ユーザーガイドを追加 #2020
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: build and deploy workflow | |
| # 製品版もビルドできる。製品版ビルド時の違いは以下の3点 | |
| # 1. production環境を使う | |
| # 2. 製品版リポジトリのコードをmergeする | |
| # 3. RESOURCEリポジトリからモデルをダウンロードして置き換える | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| version: | |
| description: "バージョン情報（A.BB.C / A.BB.C-preview.D）" | |
| required: true | |
| code_signing: | |
| description: "コード署名する" | |
| type: boolean | |
| required: false | |
| default: false | |
| is_production: | |
| description: "製品版をビルドする" | |
| type: boolean | |
| required: false | |
| default: false | |
| release: | |
| types: | |
| - published | |
| pull_request: | |
| push: | |
| env: | |
| VOICEVOX_RESOURCE_VERSION: "0.15.0-preview.3" | |
| VOICEVOX_FAT_RESOURCE_VERSION: "0.15.0-preview.4" | |
| # releaseタグ名か、workflow_dispatchでのバージョン名か、'0.0.0'が入る | |
| VERSION: ${{ github.event.release.tag_name || inputs.version || '0.0.0' }} | |
| PRODUCTION_REPOSITORY_TAG: "0.15.0-preview.2" # 製品版のタグ名 | |
| # 簡易テストとするかどうか。releaseとworkflow_dispatch以外は簡易テストとする | |
| IS_SIMPLE_TEST: ${{ github.event_name != 'release' && github.event_name != 'workflow_dispatch' }} | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| config: # 全 jobs で利用する定数の定義。実行対象の条件をフィルタリングする。 | |
| runs-on: ubuntu-latest | |
| outputs: | |
| includes: ${{ steps.strategy_matrix.outputs.includes }} | |
| deploy: ${{ env.VERSION != '0.0.0' }} | |
| version: ${{ env.VERSION }} | |
| steps: | |
| - name: declare strategy matrix | |
| id: strategy_matrix | |
| run: | | |
| includes='[ | |
| { | |
| "os": "windows-2019", | |
| "features": "", | |
| "target": "x86_64-pc-windows-msvc", | |
| "artifact_name": "windows-x64-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "windows-2019", | |
| "features": "directml", | |
| "target": "x86_64-pc-windows-msvc", | |
| "artifact_name": "windows-x64-directml", | |
| "whl_local_version": "directml", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": false | |
| }, | |
| { | |
| "os": "windows-2019", | |
| "features": "", | |
| "target": "x86_64-pc-windows-msvc", | |
| "artifact_name": "windows-x64-cuda", | |
| "whl_local_version": "cuda", | |
| "use_cuda": true, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "windows-2019", | |
| "features": "", | |
| "target": "i686-pc-windows-msvc", | |
| "artifact_name": "windows-x86-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "ubuntu-20.04", | |
| "features": "", | |
| "target": "x86_64-unknown-linux-gnu", | |
| "artifact_name": "linux-x64-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "ubuntu-20.04", | |
| "features": "", | |
| "target": "x86_64-unknown-linux-gnu", | |
| "artifact_name": "linux-x64-gpu", | |
| "whl_local_version": "cuda", | |
| "use_cuda": true, | |
| "can_skip_in_simple_test": false | |
| }, | |
| { | |
| "os": "ubuntu-20.04", | |
| "features": "", | |
| "target": "aarch64-unknown-linux-gnu", | |
| "artifact_name": "linux-arm64-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "ubuntu-20.04", | |
| "features": "", | |
| "target": "aarch64-linux-android", | |
| "artifact_name": "android-arm64-cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "ubuntu-20.04", | |
| "features": "", | |
| "target": "x86_64-linux-android", | |
| "artifact_name": "android-x86_64-cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "macos-11", | |
| "features": "", | |
| "target": "aarch64-apple-darwin", | |
| "artifact_name": "osx-arm64-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": false | |
| }, | |
| { | |
| "os": "macos-11", | |
| "features": "", | |
| "target": "x86_64-apple-darwin", | |
| "artifact_name": "osx-x64-cpu", | |
| "whl_local_version": "cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "macos-12", | |
| "features": "", | |
| "target": "aarch64-apple-ios", | |
| "artifact_name": "ios-arm64-cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "macos-12", | |
| "features": "", | |
| "target": "aarch64-apple-ios-sim", | |
| "artifact_name": "ios-arm64-cpu-sim", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| }, | |
| { | |
| "os": "macos-12", | |
| "features": "", | |
| "target": "x86_64-apple-ios", | |
| "artifact_name": "ios-x64-cpu", | |
| "use_cuda": false, | |
| "can_skip_in_simple_test": true | |
| } | |
| ]' | |
| # FIXME: composite action に切り出す | |
| if ${{ env.IS_SIMPLE_TEST }}; then | |
| includes=$(echo "$includes" | jq -c '[.[] | select(.can_skip_in_simple_test == false)]') | |
| fi | |
| includes=$(echo "$includes" | jq -c '[.[] | del(.can_skip_in_simple_test)]') | |
| echo "includes=${includes}" >> "$GITHUB_OUTPUT" | |
| build_and_deploy: | |
| needs: config | |
| environment: ${{ inputs.is_production && 'production' || '' }} # 製品版のenvironment | |
| strategy: | |
| matrix: | |
| include: ${{ fromJson(needs.config.outputs.includes) }} | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| ASSET_NAME: voicevox_core-${{ matrix.artifact_name }}-${{ needs.config.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@v3 # 製品版ではない場合 | |
| if: ${{ !inputs.is_production }} | |
| - uses: actions/checkout@v3 # 製品版の場合 | |
| if: inputs.is_production | |
| with: | |
| fetch-depth: 0 # 全履歴取得 | |
| token: ${{ secrets.PRODUCTION_GITHUB_TOKEN }} | |
| - name: Merge production branch | |
| if: inputs.is_production | |
| shell: bash | |
| run: | | |
| ( | |
| git remote add private ${{ secrets.PRODUCTION_REPOSITORY_URL }} | |
| git fetch private refs/tags/${{ env.PRODUCTION_REPOSITORY_TAG }} | |
| git -c user.name=dummy -c [email protected] merge FETCH_HEAD | |
| ) > /dev/null 2>&1 | |
| - name: Set up Python 3.8 | |
| if: matrix.whl_local_version | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.8" | |
| architecture: ${{ contains(matrix.artifact_name,'x86') && 'x86' || 'x64' }} | |
| - name: set up ${{ matrix.target }} | |
| uses: ./.github/actions/rust-toolchain-from-file | |
| with: | |
| targets: ${{ matrix.target }} | |
| - name: Install cross compiler for aarch64-unknown-linux-gnu | |
| if: matrix.target == 'aarch64-unknown-linux-gnu' | |
| run: | | |
| sudo apt update | |
| sudo apt install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu | |
| - uses: nttld/setup-ndk@v1 | |
| if: endsWith(matrix.target, '-linux-android') | |
| with: | |
| ndk-version: r25b | |
| - name: Set path for android | |
| if: endsWith(matrix.target, '-linux-android') | |
| run: | | |
| echo "$ANDROID_NDK/toolchains/llvm/prebuilt/linux-x86_64/bin" >> "$GITHUB_PATH" | |
| echo "AR_${{ matrix.target }}=llvm-ar" >> "$GITHUB_ENV" | |
| - name: Checkout VOICEVOX RESOURCE | |
| if: inputs.is_production | |
| uses: actions/checkout@v3 | |
| with: | |
| repository: VOICEVOX/voicevox_resource | |
| ref: ${{ env.VOICEVOX_RESOURCE_VERSION }} | |
| path: download/resource | |
| - name: Raplace resource | |
| if: inputs.is_production | |
| shell: bash | |
| run: | | |
| mv -f download/resource/core/README.md ./README.md | |
| - name: Install cargo-binstall | |
| uses: taiki-e/install-action@cargo-binstall | |
| - name: Install cargo-edit | |
| run: cargo binstall cargo-edit@^0.11 --no-confirm --log-level debug | |
| - name: set cargo version | |
| run: | | |
| cargo set-version "$VERSION" --exclude voicevox_core_python_api --exclude downloader --exclude xtask | |
| if ${{ !!matrix.whl_local_version }}; then cargo set-version "$VERSION+"${{ matrix.whl_local_version }} -p voicevox_core_python_api; fi | |
| - name: cache target | |
| uses: Swatinem/rust-cache@v2 | |
| if: ${{ !inputs.is_production }} | |
| - name: build voicevox_core_c_api | |
| shell: bash | |
| run: | | |
| function build() { | |
| cargo build -p voicevox_core_c_api -vv --features ${{ matrix.features }}, --target ${{ matrix.target }} --release | |
| } | |
| if ${{ !inputs.is_production }}; then | |
| build | |
| else | |
| build > /dev/null 2>&1 | |
| fi | |
| env: | |
| RUSTFLAGS: -C panic=abort | |
| ORT_USE_CUDA: ${{ matrix.use_cuda }} | |
| - name: build voicevox_core_python_api | |
| if: matrix.whl_local_version | |
| id: build-voicevox-core-python-api | |
| run: | | |
| rm -rf ./target/wheels | |
| pip install --upgrade poetry | |
| poetry config virtualenvs.create false | |
| (cd crates/voicevox_core_python_api && poetry install --with dev) | |
| function build() { | |
| maturin build --manifest-path ./crates/voicevox_core_python_api/Cargo.toml --features ${{ matrix.features }}, --target ${{ matrix.target }} --release | |
| } | |
| if ${{ !inputs.is_production }}; then | |
| build | |
| else | |
| build > /dev/null 2>&1 | |
| fi | |
| echo "whl=$(find ./target/wheels -type f)" >> "$GITHUB_OUTPUT" | |
| env: | |
| ORT_USE_CUDA: ${{ matrix.use_cuda }} | |
| - name: build voicevox_core_java_api | |
| if: contains(matrix.target, 'android') | |
| run: | | |
| function build() { | |
| cargo build -p voicevox_core_java_api -vv --features ${{ matrix.features }}, --target ${{ matrix.target }} --release | |
| } | |
| if ${{ !inputs.is_production }}; then | |
| build | |
| else | |
| build > /dev/null 2>&1 | |
| fi | |
| - name: Organize artifact | |
| run: | | |
| mkdir -p "artifact/${{ env.ASSET_NAME }}" | |
| cp -v crates/voicevox_core_c_api/include/voicevox_core.h "artifact/${{ env.ASSET_NAME }}" | |
| cp -v target/${{ matrix.target }}/release/*voicevox_core.{dll,so,dylib} "artifact/${{ env.ASSET_NAME }}" || true | |
| cp -v target/${{ matrix.target }}/release/voicevox_core.dll.lib "artifact/${{ env.ASSET_NAME }}/voicevox_core.lib" || true | |
| cp -v -n target/${{ matrix.target }}/release/build/onnxruntime-sys-*/out/onnxruntime_*/onnxruntime-*/lib/*.{dll,so.*,so,dylib} "artifact/${{ env.ASSET_NAME }}" || true | |
| # libonnxruntimeについてはバージョン付のshared libraryを使用するためバージョンがついてないものを削除する | |
| rm -f artifact/${{ env.ASSET_NAME }}/libonnxruntime.{so,dylib} | |
| cp -v README.md "artifact/${{ env.ASSET_NAME }}/README.txt" | |
| echo "${{ env.VERSION }}" > "artifact/${{ env.ASSET_NAME }}/VERSION" | |
| mkdir java_artifact | |
| cp -v target/${{ matrix.target }}/release/libvoicevox_core_java_api.so java_artifact/ || true | |
| - name: Code signing (Windows) | |
| if: startsWith(matrix.os, 'windows') && inputs.code_signing | |
| run: | | |
| bash build_util/codesign.bash "artifact/${{ env.ASSET_NAME }}/voicevox_core.dll" | |
| env: | |
| ESIGNERCKA_USERNAME: ${{ secrets.ESIGNERCKA_USERNAME }} | |
| ESIGNERCKA_PASSWORD: ${{ secrets.ESIGNERCKA_PASSWORD }} | |
| ESIGNERCKA_TOTP_SECRET: ${{ secrets.ESIGNERCKA_TOTP_SECRET }} | |
| - name: Upload artifact to build XCFramework | |
| if: contains(matrix.target, 'ios') | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: voicevox_core-${{ matrix.target }} | |
| path: artifact/${{ env.ASSET_NAME }} | |
| - name: Archive artifact | |
| run: | | |
| cd artifact | |
| 7z a "../${{ env.ASSET_NAME }}.zip" "${{ env.ASSET_NAME }}" | |
| - name: Upload to Release | |
| if: fromJson(needs.config.outputs.deploy) && !contains(matrix.target, 'ios') | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| prerelease: true | |
| tag_name: ${{ env.VERSION }} | |
| files: |- | |
| ${{ env.ASSET_NAME }}.zip | |
| target_commitish: ${{ github.sha }} | |
| - name: Upload Python whl to Release | |
| if: fromJson(needs.config.outputs.deploy) && matrix.whl_local_version | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| prerelease: true | |
| tag_name: ${{ env.VERSION }} | |
| files: |- | |
| ${{ steps.build-voicevox-core-python-api.outputs.whl }} | |
| target_commitish: ${{ github.sha }} | |
| - name: Upload voicevox_core_java_api artifact | |
| if: fromJson(needs.config.outputs.deploy) && contains(matrix.target, 'android') | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: voicevox_core_java_api-${{ matrix.artifact_name }} | |
| path: java_artifact | |
| build_xcframework: | |
| if: ${{ !(github.event_name != 'release' && github.event_name != 'workflow_dispatch') }} # !env.IS_SIMPLE_TEST と同じ | |
| needs: [config, build_and_deploy] | |
| runs-on: macos-12 | |
| env: | |
| ASSET_NAME: voicevox_core-ios-xcframework-cpu-${{ needs.config.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/download-artifact@v2 | |
| with: | |
| name: voicevox_core-x86_64-apple-ios | |
| path: artifact/voicevox_core-x86_64-apple-ios | |
| - uses: actions/download-artifact@v2 | |
| with: | |
| name: voicevox_core-aarch64-apple-ios-sim | |
| path: artifact/voicevox_core-aarch64-apple-ios-sim | |
| - uses: actions/download-artifact@v2 | |
| with: | |
| name: voicevox_core-aarch64-apple-ios | |
| path: artifact/voicevox_core-aarch64-apple-ios | |
| - name: Create fat binary | |
| run: | | |
| mkdir -p "artifact/voicevox_core-sim" | |
| lipo -create "artifact/voicevox_core-x86_64-apple-ios/libvoicevox_core.dylib" "artifact/voicevox_core-aarch64-apple-ios-sim/libvoicevox_core.dylib" -output "artifact/voicevox_core-sim/libvoicevox_core.dylib" | |
| - name: Create XCFramework | |
| run: | | |
| mkdir -p "artifact/${{ env.ASSET_NAME }}" | |
| # 必要なファイルだけコピー | |
| mkdir -p "Headers-sim" | |
| cp -v artifact/voicevox_core-x86_64-apple-ios/voicevox_core.h "Headers-sim" | |
| cp -v crates/voicevox_core_c_api/xcframework/Headers/module.modulemap "Headers-sim" | |
| mkdir -p "Headers-aarch64" | |
| cp -v artifact/voicevox_core-aarch64-apple-ios/voicevox_core.h "Headers-aarch64" | |
| cp -v crates/voicevox_core_c_api/xcframework/Headers/module.modulemap "Headers-aarch64" | |
| xcodebuild -create-xcframework \ | |
| -library "artifact/voicevox_core-sim/libvoicevox_core.dylib" \ | |
| -headers "Headers-sim" \ | |
| -library "artifact/voicevox_core-aarch64-apple-ios/libvoicevox_core.dylib" \ | |
| -headers "Headers-aarch64" \ | |
| -output "artifact/${{ env.ASSET_NAME }}/voicevox_core.xcframework" | |
| - name: Archive artifact | |
| run: | | |
| cd artifact/${{ env.ASSET_NAME }} | |
| 7z a "../../${{ env.ASSET_NAME }}.zip" "voicevox_core.xcframework" | |
| - name: Upload to Release | |
| if: fromJson(needs.config.outputs.deploy) | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| prerelease: true | |
| tag_name: ${{ env.VERSION }} | |
| files: |- | |
| ${{ env.ASSET_NAME }}.zip | |
| target_commitish: ${{ github.sha }} | |
| deploy_model: | |
| runs-on: ubuntu-latest | |
| needs: config | |
| env: | |
| ASSET_NAME: model-${{ needs.config.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Checkout VOICEVOX FAT RESOURCE | |
| if: inputs.is_production | |
| uses: actions/checkout@v3 | |
| with: | |
| repository: VOICEVOX/voicevox_fat_resource | |
| ref: ${{ env.VOICEVOX_FAT_RESOURCE_VERSION }} | |
| path: download/fat_resource | |
| - name: Raplace resource | |
| if: inputs.is_production | |
| shell: bash | |
| run: | | |
| rm -r ./model; mv download/fat_resource/core/model ./model | |
| - name: Create artifact | |
| run: | | |
| mkdir "artifact" | |
| mv model "artifact/${{ env.ASSET_NAME }}/" | |
| - name: Archive artifact | |
| run: | | |
| cd artifact | |
| 7z a "../${{ env.ASSET_NAME }}.zip" "${{ env.ASSET_NAME }}" | |
| - name: Upload to Release | |
| if: fromJson(needs.config.outputs.deploy) | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| prerelease: true | |
| tag_name: ${{ env.VERSION }} | |
| files: |- | |
| ${{ env.ASSET_NAME }}.zip | |
| target_commitish: ${{ github.sha }} | |
| build_java_package: | |
| runs-on: ubuntu-latest | |
| if: ${{ !(github.event_name != 'release' && github.event_name != 'workflow_dispatch') }} # !env.IS_SIMPLE_TEST と同じ | |
| needs: [config, build_and_deploy] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Rust | |
| uses: ./.github/actions/rust-toolchain-from-file | |
| - name: Set up Java | |
| uses: actions/setup-java@v2 | |
| with: | |
| java-version: "17" | |
| distribution: "adopt" | |
| - uses: nttld/setup-ndk@v1 | |
| id: setup-ndk | |
| with: | |
| ndk-version: r25b | |
| - name: Install cargo-binstall | |
| uses: taiki-e/install-action@cargo-binstall | |
| - name: Install cargo-edit | |
| run: cargo binstall cargo-edit@^0.11 --no-confirm | |
| - name: set cargo version | |
| run: | | |
| cargo set-version "$VERSION" -p voicevox_core_java_api | |
| - name: "Download artifact (android-arm64-cpu)" | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: voicevox_core_java_api-android-arm64-cpu | |
| path: artifact/android-arm64-cpu | |
| - name: "Download artifact (android-x86_64-cpu)" | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: voicevox_core_java_api-android-x86_64-cpu | |
| path: artifact/android-x86_64-cpu | |
| - name: Print tree | |
| run: tree artifact | |
| - name: Build voicevoxcore-android | |
| run: | | |
| rm -rf crates/voicevox_core_java_api/lib/src/main/resources/dll | |
| cat <<EOF | while read -r line; do | |
| android-arm64-cpu|arm64-v8a | |
| android-x86_64-cpu|x86_64 | |
| EOF | |
| IFS='|' read -r artifact_name target <<< "$line" | |
| mkdir "crates/voicevox_core_java_api/lib/src/main/resources/jniLibs/${target}/" | |
| cp -v "artifact/$artifact_name"/* "crates/voicevox_core_java_api/lib/src/main/resources/jniLibs/${target}/" | |
| done | |
| cp ${{ steps.setup-ndk.outputs.ndk-path }}/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/aarch64-linux-android/libc++_shared.so crates/voicevox_core_java_api/lib/src/main/resources/jniLibs/arm64-v8a/ | |
| cp ${{ steps.setup-ndk.outputs.ndk-path }}/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/x86_64-linux-android/libc++_shared.so crates/voicevox_core_java_api/lib/src/main/resources/jniLibs/x86_64/ | |
| cd crates/voicevox_core_java_api | |
| OS=android DEVICE=cpu gradle publishToMavenLocal | |
| - name: Package | |
| run: | | |
| cd ~/.m2/repository | |
| rm -rf dev || true | |
| zip -r /tmp/java_packages.zip . | |
| - name: Upload to Release | |
| if: fromJson(needs.config.outputs.deploy) | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| prerelease: true | |
| tag_name: ${{ env.VERSION }} | |
| files: |- | |
| /tmp/java_packages.zip | |
| target_commitish: ${{ github.sha }} | |
| download_test: | |
| needs: [config, build_and_deploy] | |
| if: fromJson(needs.config.outputs.deploy) | |
| uses: ./.github/workflows/download_test.yml | |
| with: | |
| version: ${{ inputs.version }} |