JetBrains IDE で GitHub Actions の実行を見る
IntelliJ IDEA・PyCharm・WebStorm・Rider などの JetBrains IDE で使える、GitHub Actions のワークフローの実行の無料の受信箱です。 作業しているすべてのリポジトリから、気にしている実行(自分がプッシュした・始めたもの、自分のコミットのもの、チェックアウト中のブランチのもの、失敗したもの、自分のレビュー待ちのもの)を IDE のツールウィンドウの1つの一覧に集め、ジョブ・ステップ・ログと一緒に見せます。画面は日本語です。
JetBrains Marketplace で入れる(読むのは無料・再実行などは30日間の無料試用つき)
ほかの選択肢との比べ方はこちら。同じ IDE で GitHub のレビュー待ちのプルリクを見るなら:GitHub のプルリクのプラグイン(英語)。
このプラグインは GitHub, Inc. と提携しておらず、後援・承認も受けていません。
こんな人向け
- プッシュのたびに、ブラウザで GitHub の Actions のタブを開いて結果を待っている
- リポジトリが多く、自分に関係する実行だけを1か所で見たい
- 社内の GitHub Enterprise Server を、プロキシや自社の証明書の下で使いたい
- コードやログを AI や外部のサーバーに送るツールは社内で使えない
実行
- このプロジェクトのリポジトリは設定なしで:Git のリモートから読みます(フォークも)
- ほかのリポジトリは、owner/repository かブラウザのアドレスを貼り付けて、または組織の全リポジトリを足せる。トークンがあれば、最近自分が動いたリポジトリも
- 絞り込み:自分の(自分がプッシュした・始めた、自分のコミットの)、いまのブランチ、失敗、レビュー待ち
- 1行ごとに、状態、ワークフローと実行の番号、題名、ブランチ、何が始めたか、何回目の試行か、かかった時間、いつ
- GitHub Actions の CI のビルドの見張り:自分の実行やいまのブランチの実行が終わると、失敗したジョブのログへのリンクつきで通知。いまのブランチの実行をステータスバーに
詳しい中身とログ
- コミット、プルリク、始めた人、ワークフローのファイル(プロジェクトにあればエディターで開く)
- ジョブとそのステップ、状態、かかった時間、ランナー。失敗したジョブを先に開く
- 下のコンソールにジョブのログを。色つき、グループとエラーの行に印、検索できる。ステップをダブルクリックすると、そのステップが始まるところでログが開く。リポジトリのログの保存期間より古い実行には、もうログがない(「HTTP 410: Server Error」)
操作
- 失敗したジョブ・すべてのジョブ・1つのジョブを再実行(デバッグのログつきにもできる・デバッグログで増える物と ACTIONS_STEP_DEBUG)
- 動いている実行をキャンセル(止まらない実行と force-cancel・「Waiting for a runner to pick up this job」のまま動かないジョブ)
- ワークフローを実行:
workflow_dispatchのあるワークフローを、ブランチかタグを選んで。入力ごとの欄(文字・選択・チェックボックス・数・環境)、既定値は入った状態で、値は覚えておくこともできる(GitHub が「Workflow does not have 'workflow_dispatch' trigger」と答えるとき) - 自分のレビューを待っているデプロイを、コメントつきで承認・却下(承認できる人と、GitHub が承認させない場合)
GitHub が再実行できるのは最初の実行から30日までで、それより古い実行には「Unable to retry this workflow run because it was created over a month ago」と答えます(ワークフローをもう一度動かす方法)。
無料と有料
無料:リポジトリをまたいだ実行の履歴・ジョブとステップ・ジョブのログ・通知・ステータスバー。有料(プラグイン内では「Pro」と表示・30日間の無料試用):ジョブの再実行・実行のキャンセル・ワークフローの実行・デプロイのレビュー。
ライセンスは JetBrains Marketplace で販売しています。個人は月 US$1.50・年 US$15、組織は1人あたり月 US$3・年 US$30(Marketplace ではお住まいの通貨で表示されます)。 読むのは誰でも無料なので、チームで IDE から再実行・キャンセル・ワークフローの実行・デプロイの承認をする人だけがライセンスを持てば足ります。試用やライセンスが終わっても読むのはそのままで、止まるのはこれらの操作だけです。
チームで買うとき:組織ライセンスは JetBrains Account で管理し、管理者が開発者に割り当てます(社内の JetBrains License Server からも配れます)。支払いはカードか PayPal。注文書や銀行振込で払うときは、Marketplace のプラグインの値段のページの Get Quote で見積もりを取れます。
入れ方
JetBrains Marketplace から入れるか、IDE の設定のプラグインで Marketplace(マーケットプレイス)のタブを開き、Pipeline Inbox for GitHub Actions Workflows を検索します。 右のツールウィンドウのバーの Workflow Runs を開くと、このプロジェクトのリポジトリはもう入っています。ほかは リポジトリを追加… で足します。
対応する環境
- github.com、GitHub Enterprise Server(
https://github.example.com)、GHE.com。ホストはいくつでも、それぞれにトークン - github.com の公開リポジトリはトークンなしで(その場合 GitHub は1時間に60回までで、ログは読めません)
- 呼び出しは少なく:一覧は前の答えの ETag をつけて読むので、変わっていない一覧は GitHub の1時間の上限を減らしません
- IDE の HTTP プロキシ設定(プロキシのログインも)と、IDE が信頼する証明書(自己署名や自社の証明書)
- Git を使える JetBrains IDE ならどれでも(IntelliJ IDEA・Rider・PyCharm・WebStorm・GoLand・PhpStorm・CLion・RubyMine など)。2024.1 以降。IDE に同梱の GitHub プラグインには頼りません
トークン
非公開のリポジトリ・ジョブのログ・有料の操作には、GitHub のホストで個人用アクセス トークンを作ります。 Fine-grained なら、選んだリポジトリに対して Actions の読み書き、Contents の読み取り、Deployments の読み書き(デプロイのレビューに)。 classic なら repo と workflow のスコープ。無料の機能は読み取りの権限だけで足ります。 ホストごとに 設定 | ツール | Pipeline Inbox for GitHub Actions に入れます。トークンはそれぞれ IDE のパスワード保管庫に入り、そのホストにだけ送られます。 ジョブのログは、GitHub がそのために渡すアドレスから、トークンなしで読みます。 トークンがないと、GitHub の API は公開リポジトリでもログを「Must have admin rights to Repository.」で断ります(その意味)。 Fine-grained のトークンで「Resource not accessible by personal access token」と返るなら、その操作に要る権限が足りないか、トークンがそのリポジトリに届いていません(見分け方)。
社内で使ってよいか判断するために
- 通信先:設定にある GitHub のホストと、ジョブのログのための GitHub のログの置き場だけ
- AI 機能なし・こちらのクラウドなし:コードもログも、AI のサービスにもこちらのサーバーにも送りません
- 計測なし:利用状況は集めません。ライセンスの確認は IDE が JetBrains Marketplace を通して行います
- トークン:ホストごとに IDE のパスワード保管庫に入れ、そのホストにだけ送ります
画面の文言は日本語で表示されます。GitHub から届くメッセージやワークフロー名はそのままです。
お問い合わせ
- プライバシーポリシー・使用許諾契約(英語)
- お問い合わせ:support@lesstep.com(日本語で大丈夫です)
GitHub と GitHub Actions は GitHub, Inc. の商標です。