Java APIを"正式"に出す

[qryxip]

内容

Java APIは0.15.0-preview.12からGitHub Releasesに含まれており、0.15.0-preview.13から0.15.0-preview.16まで続投、0.16.0のリリース前に #1044 が行われたものの 0.16.0でもそのまま含まれるといった状況です。

一方でドキュメントでの説明も欠けており、さりとて完全に秘匿されている形でもないし実験的機能であるという明言もなされていない状態です。

幸いにして次の課題を解決すれば、実験的でもなく「正式」にリリースを銘打てるはずなので、この微妙な状態は解消されると思います。

• feat: Java APIのPC用ビルドを追加 #764
• docs: Java APIの封を解く #1095
• Kotlin exampleをJava exampleに書き直す
• example/kotlin改めexample/javaへのリンク
  • usage.mdからのリンク
  • voicevox_core_java_api/README.mdからのリンク
    (voicevox_core_c_api/README.mdからexample/cppへのリンクも無いので、一緒にやるとよさそう)
• GitHub Releasesでのリリースノートにてどういう形でjava_package.zipについて言及するのかを決め、またリリースノートに書くのを忘れないようにする

Pros 良くなる点

Cons 悪くなる点

実現方法

VOICEVOXのバージョン

OSの種類/ディストリ/バージョン

その他

[Hiroshiba]

issue作成ありがとうございます！！

実験的でもなく「正式」にリリースを銘打てるはずなので

実験的機能としてリリースするか、普通に正式リリースするかは未確定だという認識です！
#1095 (comment)

ちょっとこの「実験的機能としてリリースするか、正式リリースにするか、どうするか決めるという」タスクをリストに追加しておいていただけると･･･！
（あるいはこちらで勝手に追加しちゃってもいいでしょうか？）

あるいはここで議論してどうするか決まってからタスク分割していくとかもありだと思います！

[Hiroshiba]

Java周りに関して、ざっと見回して気になった点です：

1. java_packages.zipの使い方がどこにも書いてない･･･？
   • リポジトリ全体をjava_packagesで検索してもサンプルもドキュメントもヒットしない
   • タスクリストに リリースノートにてどういう形でjava_package.zipについて言及するのかを決め とあるけど、そもそもjava_package.zipはどういう立ち位置なのかとか、exampleで使うようにするのかとか、ドキュメントから案内しないのかとか整理が必要だったり･･･？

色々あるかなと思ったけど見つけたのは1個だけでした！

[sevenc-nanashi]

java_packages.zip、正直言うとめちゃめちゃ使いづらいんですよね。

記憶が正しければ：mavenはパッケージに依存関係が書いていない（Pythonで言うならMETADATAなどのファイルがwhlに入ってない感じ）ので、いい感じに依存関係とかを含めてまとめられるフォーマットとしてpublishToMavenLocalとzipを使った記憶があります。

本来はこれはレジストリを建てて配信した方が何倍もいいはず。
レジストリ建てるのはリリースに必須だと思います。

[Hiroshiba]

なーーーーーーーるほどです！！！
たぶんexample/kotlinの挙動は

• java_packages.zipを使っていない
• cargo buildでjavaパッケージ？的なのローカルに作ってからjava exampleを動かすようになってる

って感じな気がしますね！
となると多分exampleはもうちょっと分かりやすいように（せめてcargo buildが必要なことがわかるように）作らないと、ユーザー視点でサンプルとしてかなり難しそう･･･？

[sevenc-nanashi]

メモ：

• Javaレジストリはjava_packages.zipをマージすればできる：https://github.com/sevenc-nanashi/vv_core_registry/blob/main/inject.ts#L167

• 過去の自分によると、40回リリースするとGH Pagesの上限を突破する：https://discord.com/channels/879570910208733277/1153284067140317235/1153670186973544530

• こんなことをしなくとも、maven centralにあげれば全て解決する

  • 当時の会話：https://discord.com/channels/879570910208733277/893889888208977960/1164120738110914570
  • 今は状況が変わっていて、無人でできるっぽい
  • io.github.voicevoxは確実に取れる、他にもドメインがあればDNS設定で取れる

• related: Java版の配布形式をどうするか（Maven Central？） #651