unagirabbit's blog

気づいたことをメモしています

【Jenkins】VSCodeからJenkinsのPipelineを編集/ビルドする

Jenkins

他に良いプラグインがありました。

unagirabbit.hatenablog.com

JenkinsのPipelineをテストするとき、都度ページを開いてビルドするのは手間ですよね。
jenkins-runnerは手元で編集しているPipelineを指定のJenkins上で実行する事ができます。
Jobの設定を上書きしてしまうので、テスト用のJobで試すのが良いでしょう。
新しいPipelineを書いてみよう、という時に大変重宝しています。

jenkins-runner

詳しくはGitHubをご覧ください。 github.com

できること

  • VSCode上だけでPipelineのトライアルアンドエラー！

  • 複数のJenkinsとJobを登録してテスト

  • パラメーターを指定してのビルド

  • 構文エラーをEditor上でハイライト

  • ビルド出力をVSCodeの出力に表示

インストールと設定

1. 拡張機能でJenkins Runnerをインストール

MarketPlaceのページはこちら
https://marketplace.visualstudio.com/items?itemName=dave-hagedorn.jenkins-runner

2. settingsにJenkinsのホストとJobの設定を行う

Jenkinsのホスト

JenkinsのURLを設定します。
セキュリティを有効にしている場合はuserとpasswordを設定してください。

"jenkins-runner.hostConfigs": {
    "local": {
        "url": "http://localhost:8080"
    },
    "local-secure": {
        "url": "http://localhost:8090",
        "user": "ユーザー名",
        "password": "パスワード"
    }
}

Jobの設定

"jenkins-runner.jobs": {
    "test 1 - defaults": {
        "isDefault": true, // コマンドでデフォルト実行するならtrue
        "runWith": ["local", "local-secure"], // hostConfigsで設定したホスト名
        "name": "test-pipeline", // ビルドするJobの名前
    },
    "test 1 - other params": {
        "runWith": "local-secure",
        "name": "test-pipeline",
        "parameters": {
            "param1": "Hello World!"
        }
    }
}

3. VSCodeのコマンドからJenkins Runnerを実行

Default Jobの方だとisDefaultをtrueにしたものが実行されます。