GitHub CLI に GitHub Actions 用コマンドが追加された

1.0 では対応してませんでした。

blog.kondoumh.com

今月の中旬にリリースされた v1.9.0 で run, workflow, actions のコマンド群が提供されました。

github.blog

actions でコマンド一覧が表示できます。

$ gh actions

f:id:kondoumh:20210429150834p:plain

run はワークフロー実行結果や詳細を見るためのコマンド。workflow はワークフローファイルの管理や起動のめのコマンドのようです。

リポジトリのワークフロー実行結果一覧を取得するには run list サブコマンドを使用します。

$ gh run list

f:id:kondoumh:20210429143053p:plain

ワークフロー起動時のコミット、ワークフロー名、ブランチ、トリガー、run ID が取得されます。

実行中のワークフローをウォッチするには run watch サブコマンドを使用します。

$ gh run watch

f:id:kondoumh:20210429145055p:plain

実行中のジョブを選択できて、選択するとワークフローのジョブごとにステップの実行結果が順次出力されていきます。Web UI だとステップごとの結果はジョブをクリックしないと見れませんので一覧性は高くなっています。

f:id:kondoumh:20210429145247p:plain

run view サブコマンドで run ID を指定して実行結果の詳細を取得できます。

$ gh run view <run ID>

f:id:kondoumh:20210429150136p:plain

Web UI もよくできているのででエラー箇所を見るのは簡単ですが、CLI を使うと grep などと組み合わせて出力を加工できるのでこれはこれで便利です。

この他ワークフローを再実行する run rerun や ワークフロー実行により生成された Artifact をダウンロードする run download などのサブコマンドも提供されています。

ワークフローファイルの一覧は workflow list サブコマンドで取得できます。

$ gh workflow list

f:id:kondoumh:20210429152131p:plain

ワークフロー名を指定して実行できます。

$ gh workflow run <workflow name>

f:id:kondoumh:20210429152523p:plain

実行後は run watch で実行状態を監視できます。

今のところ実行できるのは workflow_dispatch トリガーを持つワークフローだけです。このトリガーを持たないワークフローを実行しようとするとエラーになります。

f:id:kondoumh:20210429153048p:plain

実行後は run watch で実行状態を監視できます。

ブラウザでポチポチしなくてもワークフローの状態を調べることができるようになって便利になりました。

ワークフロー一覧はもう少し属性情報を出して欲しいですね。workflow view サブコマンドで詳細が出ますが、YAML の解析が大変なのかも? あとworkflow_dispatch だけでなく webhook イベントでトリガーするrepository_dispatch の実行にも対応して欲しいところです。