逆引きマニュアル: IntelliJ IDEA: Jenkinsfileの文法を認識させる方法

やりたいこと

JenkinsfileはGroovyで書かれていますが、 その文法を認識させる方法です。

前提条件

IntelliJ IDEA 2018.1.3で確認しています。

概要

GDSL(Groovy DSL)ファイルを使用します。

1. GDSLファイルを入手する
2. GDSLファイルをソースフォルダに配置する
3. JenkinsfileをGroovyのコードとして認識させる

手順

GDSLファイルを入手

• Scripted Pipelineの場合
  • 公式で対応しています。
  • 以下のGistに概要が書かれています。
    • Get Jenkins GDSL working with IntelliJ IDEA
  • 手順
    1. 適当なPipelineプロジェクトを開きます¹。
    2. 左側のメニューから"Pipeline Syntax"を選択します。
    3. 左側のメニューから"IntelliJ IDEA GDSL"を選択します。
    4. 表示された内容を拡張子.gdslとして保存します。
• Declarative Pipelineの場合
  • 公式では対応していません(JENKINS-40127)
  • 作成している人がいます。
    • GDSL supporting pipeline declarative

以下では、Declarative Pipelineを使って作業します。

ソースフォルダに配置

取得したファイルをソースフォルダに配置します。 IntelliJ IDEAがソースフォルダと認識できればいいので、 既存のディレクトリではなく、src/main/groovy 以下に置いて、 設定で認識させるのでもOKです。

次にファイルを開きます。以下の警告が出ますが、 これはActivate Backをクリックしてください。

DSL descriptor file has been changed and isn’t currently executed.

Jenkinsfileを認識させる

1. Preferences / Settingsを開く
2. Editor -> File Typesを選択
3. Recognized File Types: Groovyを選択
4. Registered PatternsにJenkinsfileを追加

補足

使ってみましたが、まだ不十分みたいです。 Groovy DSLを勉強して何とかしたいですね。。。

• agent anyが認識されない。
• toolsが認識されない。

マニュアル

• IntelliJ IDEA
• Jenkins

---