GitHub Actions の進行状況を CLI で確認できる hukum を使ってみる

またもや GitHub Actions の話。

GitHub Actions の動作を確認したくて、git push した直後に GitHub の画面を開いたりするが、もっとサクッと見たいところ。

そこで、GitHub Actions の進行状況を CLI で確認できる hukum を試してみた。

• GitHub - abskmj/hukum: An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime.

とりあえず使ってみる

hukum は npm でインストールできる。

$ npm install -g hukum

通常どおり、GitHub Actions Workflow を管理しているプロジェクトで git push などをして、GitHub Actions を発火させたら、すぐに hukum コマンドを実行する。

$ hukum

すると CLI 上で GitHub Actions の進行状況が確認できる。

GitHub トークンを用意する

hukum は内部的に GitHub API をコールして進行状況を取得しているので、多用すると API コールレート制限に引っ掛かってしまうことがある。

そこで、GitHub アクセストークンを用意し、プロジェクトディレクトリ直下に .hukumrc として保存しておくと、GitHub アクセストークンを利用して API をコールしてくれる。

• .hukumrc

{
  "github": {
    "token": "【GitHub アクセストークン】"
  }
}

以前 hukum が動かなかったが、直してもらえた

当初、自分の環境では hukum がうまく動かなかった。よくよくコンソール表示を見てみると、リポジトリ名の特定にミスっているようだった。

どうも実装上の不備で、git clone 時の URL 中にユーザ名を含んでいると上手く動かないようだ。

どういう URL かというと、以下のような URL。

$ git remote -v
origin  https://Neos21@github.com/Neos21/HOGE.git (fetch)
origin  https://Neos21@github.com/Neos21/HOGE.git (push)

URL 中の Neos21@ 部分があると、当時は hukum が上手く動かなかった。

• 参考
  • git push で毎回ユーザ名とパスワードを入力しないようにする
  • GitHub のパスワードを変えたので、パスワード入りで git clone していたリポジトリの設定を修正する

この件は Issue 報告して、ソース修正こそしていないものの、実装の問題点も指摘はした (← 直したれよ俺)。

• Error: Request failed with status code 404 · Issue #14 · abskmj/hukum

そしたら数日後に修正してもらえて、現在はユーザ名付きの URL であっても上手く実行できるようになっている。hukum v1.4.0 では修正されている。

• 参考：Add regex for repo name, fixes #14 · abskmj/hukum@e8f6f26 · GitHub

自分でコードを直接直さなくても、バグを見つけたら報告しておくと、こうやって直してもらえたりする。OSS の素敵なところ。

以上～。