最初に
どうも、ろっさむです。
今回は、VSCodeを用いてjenkinsfileを作成し、VSCode上であれこれ便利に編集する方法をまとめていきます。
Jenkinsのジョブ自体を久しぶりにメンテナンスする際に、構文がうろ覚え状態になることもあると思います。ですので、キーワード補間や、jenkinsfile側の構文に問題がないかをチェックするプラグインを使用して、快適に開発を進めましょう。
開発環境
- Visual Studio Code：1.52.1
- Windows：Windows10
- Jenkins：2.263.1
- Decarativve Pipelineを使用
今回おすすめするプラグイン
JenkinsFile Support
JenkinsFile Supportは、jenkinsfileを作成するにあたって必要になるキーワード補間やシンタックスハイライトなどの機能を提供してくれるプラグインです。
入れると以下のような感じになり、コーディングしやすくなります。
Jenkins Pipeline Linter Connector
Jenkins Pipeline Linter Connectorは構文が正しいかどうかをチェックすることができるプラグインです。
セットアップ
プラグインの画面にある歯車から、Extension Settingsを押下します。
必要な設定は以下の通りです。
| 項目 | 概要 | 設定 |
|---|---|---|
| Url | Jenkins上のvalidaterのURL | http://[Jenkinsのダッシュボードを開いたときのURL]/pipeline-model-converter/validate (もしアドレスがデフォルトの場合は http://localhost:8080/pipeline-model-converter/validate) |
| Strictssl | JenkinsでSSL化している場合は設定が必要 |
falseにするとinvalidのssl接続を許可します |
| User | Jenkinsユーザー名 | |
| Pass | Userで指定したユーザーのパスワード |
使用方法
設定が完了したら保存し、jenkinsfileを開いた状態でコマンドパレット(Ctrl + Shift + P)から Validate Jenkinsfileを実行するか、ショートカットキーである Shift + Alt + Vを押下してください。
そうするとOUTPUTに構文チェック結果が表示されます。
「Jenkinsfile successfully validated.」と表示されたら構文に問題はありません。
Bracket Pair Colorizer 2
Bracket Pair Colorizer 2は対応する括弧同士を色で認識することができるようになります。
installするとこんな感じに↓
Jenkins側でのjenkinsfileを読み込む設定
まずはjenkinsfileをリポジトリ内の任意の場所に追加し、pushしておきます。
「パイプライン > 定義」を「Pipeline script from SCM」に変更し、SCMをGitかSubversionに変更します。RepositoryのURLやCredentials（ユーザー名とパスワード設定をここで行う）を設定します。また、「Local module directory」にはそのジョブが存在するワーキングディレクトリからのcloneしてあるディレクトリへ相対パスを記述する必要があります。
ここまでやれば、コード自体のバージョン管理ができるようになります！