JetBrains IDE で Jenkins® のビルドを見る
IntelliJ IDEA・PyCharm・WebStorm・Rider などの JetBrains IDE で使える、Jenkins のビルドの無料の受信箱です。 使っているすべての Jenkins から、気にしているビルド(自分が始めたもの・自分のコミットをビルドしているもの・チェックアウト中のブランチのもの)を IDE のツールウィンドウの1つの一覧に集め、Pipeline の段・失敗したテスト・コンソールのログと一緒に見せます。画面は日本語です。
JetBrains Marketplace で入れる(読むのは無料・ビルドの実行などは30日間の無料試用つき)
ほかの選択肢との比べ方はこちら。
このプラグインは Jenkins プロジェクトと提携しておらず、承認も受けていません。
こんな人向け
- ビルドの結果やログを見るたびに、ブラウザで Jenkins を開いている
- Jenkins のサーバーが複数あり、自分に関係するビルドだけを1か所で見たい
- ビルドが数千あるマルチブランチ プロジェクトでも、待たされずに一覧を出したい
- コードやログを AI や外部のサーバーに送るツールは社内で使えない
ビルド
- ジョブ・フォルダー・マルチブランチ プロジェクト(ブランチとプルリク)を、Jenkins のサーバーいくつからでも、IDE のプロジェクトごとに選べる。サーバーのジョブの木から選ぶか、ブラウザからジョブのアドレスを貼り付ける
- 絞り込み:自分の(自分が始めた・自分のコミットをビルドしている)、いまのブランチ、失敗・不安定
- 1行ごとに、状態、ジョブとブランチ、コミットかプルリク、何が始めたか、失敗したテストの数、かかった時間か残りの時間、いつ
- 大きなマルチブランチ プロジェクトでも、動いているジョブだけを、一覧に要る項目だけで読む。ビルドが数千あるサーバーでも時間切れにならない
- CI のビルドの見張り:自分のビルドやいまのブランチのビルドが終わると、コンソールへのリンクつきで通知。いまのブランチの最新のビルドをステータスバーに
詳しい中身とログ
- ビルドを始めた人や仕組み、ビルドしたコミット、パラメーター、上流のビルド
- Pipeline の段を状態とかかった時間つきで(Pipeline: Stage View か Pipeline Graph View のプラグインから)。段をダブルクリックすると、その段が始まるところでコンソールが開く
- 失敗したテストを Jenkins の理由つきで。それぞれのページを開ける
- 下のコンソールにログを。AnsiColor の色つきで、検索でき、動いているビルドは書かれるそばから追う
操作
- パラメーターつきでビルドを実行(Build Now):パラメーターごとの入力欄(文字・選択・チェックボックス・パスワード)、既定値は入った状態で。値はジョブごとに覚えておくこともできる(パスワードは覚えない)。Jenkins がビルドを待ち行列に置いたままなら、知らせにその理由を添える(「Waiting for next available executor」とほかの理由)
- 同じパラメーターでもう一度ビルド(先に直すこともできる)
- 動いているビルドを止める(中止できない Pipeline のビルド)
- Pipeline の入力のステップで、続行か中止を選ぶ(答えられる人と、curl で送る住所)
無料と有料
無料:ビルドの一覧・Pipeline の段・失敗したテスト・コンソールのログ・通知・ステータスバー。有料(プラグイン内では「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 Jenkins を検索します。 設定 | ツール | Pipeline Inbox for Jenkins で Jenkins のサーバーを足し、右のツールウィンドウのバーの Jenkins Builds を開いて ジョブを追加… を押します。
対応する環境
- Jenkins のサーバーはいくつでも。それぞれにユーザー名と API トークン。パスの下にあるサーバー(
https://example.com/jenkins)も、Jenkins 自身のアドレスの設定が間違っているサーバーも使えます - フリースタイルと Pipeline のジョブ、フォルダー、マルチブランチ プロジェクトとそのブランチ・プルリク
- サーバーにあれば、Pipeline: Stage View か Pipeline Graph View のプラグインの段(Blue Ocean からの乗り換え)、JUnit のテストの結果、AnsiColor の色
- IDE の HTTP プロキシ設定(プロキシのログインも)と、IDE が信頼する証明書(自己署名や自社の証明書)
- Git を使える JetBrains IDE ならどれでも(IntelliJ IDEA・Rider・PyCharm・WebStorm・GoLand・PhpStorm・CLion・RubyMine など)。2024.1 以降
マルチブランチ プロジェクトがビルドするプルリクそのものには、Lesstep のレビューの受け箱があります(どれも別のプラグイン):Bitbucket・GitHub・GitLab・Azure DevOps・Forgejo と Gitea。
API トークン
誰でも読める Jenkins なら、トークンなしで動きます。それ以外のとき、またビルド・中止・承認をするときは、Jenkins で API トークンを作ります。
自分のユーザーのページ(右上の自分の名前)を開き、Security、API Token、Add new Token の順に進みます。
サーバーごとに、ユーザー ID とトークンを 設定 | ツール | Pipeline Inbox for Jenkins に入れます。トークンはそれぞれ IDE のパスワード保管庫に入り、そのサーバーにだけ送られます。
API トークンを使うと、Jenkins は CSRF のクラム(crumb)を求めません(「403 No valid crumb was included in the request」の解説)。
「anonymous is missing the Overall/Read permission」(anonymous には、全体/Read パーミッションがありません)と言われたら、トークンが Jenkins に届いていません(訳と送り方)。401 で答えるなら、届いたうえで組を受け付けていません(どちらが違うかの確かめ方)。
パラメーター付きのジョブの /build にスクリプトから POST すると HTTP 400「Nothing is submitted」になります。そのジョブは /buildWithParameters で起動します(コマンド)。
jenkins-cli.jar が「CLI handshake failed with status code 403」で止まるなら、その裏にある Jenkins URL の確認と、2つの直し方を見てください。
社内で使ってよいか判断するために
- 通信先:設定で足したか、ジョブのアドレスを貼り付けて足した Jenkins のサーバーだけ
- AI 機能なし・こちらのクラウドなし:コードもログも、AI のサービスにもこちらのサーバーにも送りません
- 計測なし:利用状況は集めません。ライセンスの確認は IDE が JetBrains Marketplace を通して行います
- トークン:サーバーごとに IDE のパスワード保管庫に入れ、そのサーバーにだけ送ります
画面の文言は日本語で表示されます。Jenkins から届くメッセージやジョブ名はそのままです。
お問い合わせ
- プライバシーポリシー・使用許諾契約(英語)
- お問い合わせ:support@lesstep.com(日本語で大丈夫です)
Jenkins® は LF Charities Inc. の登録商標です。Bitbucket・GitHub・GitLab・Azure DevOps・Forgejo・Gitea はそれぞれの持ち主の商標です。