追加: actionlint CI

[tarepan]

内容

actionlint を CI に追加し GitHub Actions workflow の自動 linting を追加した。

ShellCheck 未導入のため、actionlint-ShellCheck 連携は現段階で導入していない。

関連 Issue

resolve #525 (final step 🎉)

[Hiroshiba]

シェルスクリプトはなかなか記法が難しいので、もしどうすれば良いかわからないのあればお聞きください！
（自分もわからないかもですが、誰がわかるかもしれない）

[tarepan]

残エラー

パスの変更

エラー: .github/workflows/build-engine-package.yml:151:9: shellcheck reported issue in this script: SC1003:info:3:72: Want to escape a single quote? echo 'This is how it'\''s done' [shellcheck]

該当箇所:

voicevox_engine/.github/workflows/build-engine-package.yml

Line 154 in b91d076

CUDA_ROOT=$( echo "${{ steps.cuda-toolkit.outputs.CUDA_PATH }}" | tr '\\' '/' )

CUDAのセットアップ出力であるパスを編集している模様。期待出力がわからず手を入れづらい。

変数ぽい何か

エラー: .github/workflows/build-engine-package.yml:525:9: shellcheck reported issue in this script: SC2016:info:4:22: Expressions don't expand in single quotes, use double quotes for that [shellcheck]

該当箇所:

voicevox_engine/.github/workflows/build-engine-package.yml

Line 529 in b91d076

patchelf --set-rpath '$ORIGIN' "$(pwd)/download/onnxruntime/lib"/libonnxruntime_providers_*.so

$ORIGIN が指している対象がわからない。変数ではなく内部コマンド的な何か？

cat

エラー: .github/workflows/test-engine-package.yml:72:9: shellcheck reported issue in this script: SC2002:style:3:5: Useless cat. Consider 'cmd < file | ..' or 'cmd file | ..' instead [shellcheck]

該当箇所:

voicevox_engine/.github/workflows/test-engine-package.yml

Line 75 in b91d076

cat "download/list.txt" | xargs -I '%' curl -L -o "download/%" "${{ steps.vars.outputs.release_url }}/%"

私のシェル力が足りないため正解がよくわからない。

[yamachu]

CUDA_ROOT=$( echo "${{ steps.cuda-toolkit.outputs.CUDA_PATH }}" | tr '\\' '/' ) 

ここに関しては Windows 対応のためかなと思います
Windows 環境での CI の場合、ファイルパスに C:\\Program Files みたいのが入ってると思うので、それを C:/Program Files みたいなパスにしてるはずです

修正は…これは

- tr '\\' '/'
+ tr "\\" "/"

でなんとかなりませんかね…？

'$ORIGIN' は rpath のエントリ名のはずですね
shell 変数ではないので、ダブルクオートで囲むでいいと思います

 cat "download/list.txt" | xargs -I '%' curl -L -o "download/%" "${{ steps.vars.outputs.release_url }}/%" 

これは download/list.txt を1行ずつ読み取り、curl でダウンロードしています
例えば download/list.txt に以下のような内容が含まれていたら

foo.zip
bar.zip

${{ steps.vars.outputs.release_url }}/foo.zip からダウンロードしたものを download/foo.zip として保存するみたいな感じです

修正案としては

<download/list.txt xargs -I '%' curl -L -o "download/%" "${{ steps.vars.outputs.release_url }}/%" 

とかでしょうか

[sevenc-nanashi]

'$ORIGIN' は rpath のエントリ名のはずですね
shell 変数ではないので、ダブルクオートで囲むでいいと思います

これダブルクォートで囲んじゃ駄目な様な。多分Shellcheckのignoreが正解だと思います。サイト見ても「この時はignoreしてね」って書いてありますし

https://www.shellcheck.net/wiki/SC2016

[yamachu]

あぁ、そうか
その場で展開されて(おそらく)空文字になってしまいますね、ありがとうございます

[tarepan]

'$ORIGIN' は rpath のエントリ名

Shellcheckのignoreが正解

@yamachu @sevenc-nanashi
ありがとうございます！
RPATH の特殊トークンであり、シェル変数化しないようにシングルクォートでエスケープすべきということですね。
Shellcheck は false alert ということで ignore します。

[tarepan]

パスの変更

OS ごとの差異吸収とのことだったので GitHub Actions を用いて検証しました。

• CUDA_PATH
  • Windows NVIDIA GPU: C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.8
  • Linux NVIDIA GPU: /usr/local/cuda-11.8
• CUDA_ROOT
  • Windows NVIDIA GPU: C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8
  • Linux NVIDIA GPU: /usr/local/cuda-11.8

@yamachu さんの指摘通り、パス区切りの OS 差異吸収として機能しているようです。アドバイスありがとうございます！

echo "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.8" | tr "\\" "/" を実行すると tr: warning: an unescaped backslash at end of string is not portable という警告がでました。シングルクォートは避けられ無さそうなので shellcheck ignore します。

[Hiroshiba]

LGTM！！！

maxdepthの方だけ変更適用させていただきます！

いや～～～～～～～～～～～～～～～～～～～～bashあまりにも難しいですね！！！！！！！！

ちょっと全然関係ないのですが、Deno+zxにしようというのをなんとなく検討していたりするのですが、どう思われますか･････？

[Hiroshiba]

一応こうやると迂回できそうでした。どっちがいいですかね。。。

Suggested change

	# NOTE: `$ORIGIN` は RPATH の特殊トークンであるため、bash 変数扱いされないために適切なエスケープが必要。
	# shellcheck disable=SC2016
	patchelf --set-rpath '$ORIGIN' "$(pwd)/download/onnxruntime/lib"/libonnxruntime_providers_*.so
	patchelf --set-rpath "\$ORIGIN" "$(pwd)/download/onnxruntime/lib"/libonnxruntime_providers_*.so

[tarepan]

円マークをエスケープする、なるほどその手が。
提案頂いた方がスマートに感じます。

[tarepan]

Deno+zxにしようというのをなんとなく検討していたりするのですが、どう思われますか

（Deno+zx を使ったことがないのであくまで直感です）

ENGINE への導入はなかなかメンテ性に課題あり、が第一感です。

Deno ランタイムと zx ライブラリの安定性もそうですが、Python レポジトリに JS/TS をガンガン入れていくとメンテ（実装/改変/レビュー）できる人が限られそうな予感はします。エディタでは全然ありだと思います。
bash 辛いは本当に本当にそうなので、ENGINE で Deno+zx にコスト掛けれるならいっそ Python スクリプト化を目指すほうが安牌な気がしなくもなくもないです。

[Hiroshiba]

Deno+rxは使ってみたのですが、結構ハードルは高いように感じました。
以前ほど積極的に使いたいとは感じなくなりました。

かといってpythonも、とくにコマンド実行が面倒なのが厄介な気もしますね･･･。
なんだかんだbashなんですかねー･･･