cbindgenが生成するvoicevox_core.hをこのリポジトリに追加する (VOICEVOX#493)

* cbindgenが生成するvoicevox_core.hをこのリポジトリに追加する

* ビルド時にはcbindgenは不要

* `linguist-generated`に指定

.gitattributes

@@ -0,0 +1 @@
+/crates/voicevox_core_c_api/include/voicevox_core.h linguist-generated=true

.github/workflows/build_and_deploy.yml

@@ -140,8 +140,6 @@ jobs:
           echo "AR_${{ matrix.target }}=llvm-ar" >> "$GITHUB_ENV"
       - name: Install cargo-binstall
         uses: taiki-e/install-action@cargo-binstall
-      - name: Install cbindgen
-        uses: ./.github/actions/cargo-binstall-cbindgen
       - name: Install cargo-edit
         shell: bash
         run: cargo binstall cargo-edit@^0.11 --no-confirm --log-level debug
@@ -150,9 +148,6 @@ jobs:
         run: |
           cargo set-version "$VERSION" --exclude voicevox_core_python_api --exclude download --exclude xtask
           if ${{ !!matrix.whl_local_version }}; then cargo set-version "$VERSION+"${{ matrix.whl_local_version }} -p voicevox_core_python_api; fi
-      - name: generate voicevox_core.h
-        shell: bash
-        run: cbindgen --crate voicevox_core_c_api -o ./voicevox_core.h
       - name: build voicevox_core_c_api
         run: cargo build -p voicevox_core_c_api -vv --features ${{ matrix.features }}, --target ${{ matrix.target }} --release
         env:
@@ -174,7 +169,7 @@ jobs:
         shell: bash
         run: |
           mkdir -p "artifact/${{ env.ASSET_NAME }}"
-          cp -v voicevox_core.h "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

.github/workflows/test.yml

@@ -105,7 +105,7 @@ jobs:
         shell: bash
         run: cargo test -vv --features ,${{ matrix.features }} -- --include-ignored
 
-  xtask-generate-c-header:
+  c-header:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -115,12 +115,14 @@ jobs:
         uses: taiki-e/install-action@cargo-binstall
       - name: Install cbindgen
         uses: ./.github/actions/cargo-binstall-cbindgen
-      - name: Generate voicevox_core_1.h
-        run: cbindgen --crate voicevox_core_c_api -o ./voicevox_core_1.h
-      - name: Generate voicevox_core_2.h
-        run: cargo xtask generate-c-header -o ./voicevox_core_2.h
-      - name: Assert these header files are same
-        run: diff -u --color=always ./voicevox_core_{1,2}.h
+      - name: Assert voicevox_core.h is up to date
+        run: |
+          cbindgen --crate voicevox_core_c_api -o /tmp/voicevox_core.h
+          diff -u --color=always {/tmp,./crates/voicevox_core_c_api/include}/voicevox_core.h
+      - name: Assert `cargo xtask update-c-header --verify` succeeds
+        run: |
+          cargo xtask update-c-header --verify
+          git diff
 
   build-unix-cpp-example:
     strategy:

README.md

@@ -136,18 +136,22 @@ model フォルダにある onnx モデルはダミーのため、ノイズの
 cargo build --release -p voicevox_core_c_api
 ```
 
-```bash
-# DLL用のヘッダファイルvoicevox_core.hを生成
-# cbindgenが手元にインストールされているのならそちらでも可
-cargo xtask generate-c-header
-```
+DLL用のヘッダファイルは [crates/voicevox\_core\_c\_api/include/voicevox\_core.h](https://github.com/VOICEVOX/voicevox_core/tree/main/crates/voicevox_core_c_api/include/voicevox_core.h) にあります。
 
 ## コアライブラリのテスト
 
 ```bash
 cargo test
 ```
 
+## ヘッダファイルの更新
+
+```bash
+cargo xtask update-c-header
+```
+
+[cbindgen](https://crates.io/crates/cbindgen) が手元にインストールされているなら、それを使いヘッダファイルを生成することもできます。
+
 ## タイポチェック
 
 [typos](https://github.com/crate-ci/typos) を使ってタイポのチェックを行っています。