Jenkinsパイプライン構文：初心者向け総合ガイド
Jenkinsは、継続的インテグレーション（CI）および継続的デリバリー（CD）のワークフローで広く採用されている強力なオープンソースの自動化サーバーです。Jenkinsの中核では、複雑なソフトウェアデリバリープロセスを定義、スケジュール、自動化するためにパイプラインを利用します。CI/CDのニーズに合わせてJenkinsを効果的に活用しようとする人にとって、Jenkinsパイプライン構文を理解することは極めて重要です。本ガイドは、その必須コンポーネント、一般的な構造、および堅牢で効率的なパイプラインを構築するためのベストプラクティスをカバーし、初心者向けにJenkinsパイプライン構文を紹介します。
本記事は、Jenkinsパイプライン構文の謎を解き明かし、明確な説明と実用的な例を提供することを目的としています。宣言的（Declarative）とスクリプト（Scripted）の2つの主要な構文を探り、最初のパイプラインの構築を案内します。本ガイドの終わりまでに、Jenkins内でCI/CDプロセスを作成および管理するための確固たる基盤が得られるでしょう。
Jenkinsパイプラインの理解
Jenkinsパイプラインは、C/CDパイプラインをJenkinsに実装および統合するのをサポートするプラグインのスイートです。ビルド、テスト、デプロイのプロセスをコードとして定義できるため、バージョン管理、再現性、透明性が確保されます。パイプラインは複雑になることがあり、複数のステージ、条件付きロジック、さまざまなツールとの統合を含む場合があります。これらのパイプラインを定義するために使用される構文は、それらを成功裏に実装するために重要です。
宣言的パイプラインとスクリプトパイプラインの比較
Jenkinsは、パイプラインを定義するために2つの主要な構文を提供します。
- 宣言的パイプライン (Declarative Pipeline): これは、より高いレベルの抽象化を提供する、より構造化され、意見が反映された構文です。一般的なCI/CDのユースケースにおいて、よりシンプルで、読みやすく、保守しやすい構文を提供します。宣言的パイプラインは、通常、初心者におすすめです。
- スクリプトパイプライン (Scripted Pipeline): この構文は、Groovyスクリプトを使用して、より柔軟で強力です。より大きな制御と複雑なロジックを可能にしますが、GroovyやJenkinsパイプラインスクリプトに慣れていない人にとっては、学習と保守がより困難になる可能性があります。
本ガイドでは、使いやすさと初心者への適性から、主に宣言的パイプライン構文に焦点を当てますが、関連する箇所ではスクリプトパイプラインの概念にも触れます。
宣言的パイプライン構文の必須要素
宣言的パイプラインは、Jenkinsfile（パイプラインを定義し、通常はソース管理リポジトリにチェックインされるファイル）内の pipeline {} ブロック内で定義されます。構造は階層的で理解しやすいです。
pipeline ブロック
すべての宣言的パイプラインは pipeline {} ブロックで始まります。
pipeline {
// パイプラインの設定をここに記述します
}
agent ディレクティブ
agent ディレクティブは、パイプラインまたは特定のステージがどこで実行されるかを指定します。これはパイプライン全体でグローバルに定義されたエージェントにすることも、ステージごとに定義することもできます。
agent any: 利用可能な任意のJenkinsエージェントでパイプラインを実行できます。agent { label 'my-agent-label' }: 指定されたラベルを持つエージェントでパイプラインが実行されます。agent none: グローバルなエージェントは割り当てられません。エージェントはステージごとに指定する必要があります。
例:
pipeline {
agent any
stages {
// ... ステージはここに配置されます
}
}
stages および stage ブロック
stages は、1つ以上の stage ブロックのコンテナです。各 stage は、「ビルド」「テスト」「デプロイ」など、パイプラインの明確な部分を表します。stage には、少なくとも1つの steps ブロックが含まれている必要があります。
例:
pipeline {
agent any
stages {
stage('Build') {
steps {
// ビルド手順をここに記述します
}
}
stage('Test') {
steps {
// テスト手順をここに記述します
}
}
}
}
steps ブロック
steps ブロックには、実際に実行されるコマンドまたはアクションが含まれます。これらはステージ内での個々のタスクです。
例（'Build' ステージ内）:
steps {
echo 'アプリケーションをコンパイル中...'
sh 'mvn clean install'
}
ここでは、echo はメッセージを表示し、sh はシェルコマンド（Mavenビルドなど）を実行します。その他の一般的なステップには、bat（Windowsバッチコマンド用）、git（SCM操作用）、およびプラグイン固有のステップがあります。
Post アクション
The post セクションでは、パイプライン（またはステージ）が成功したか失敗したかにかかわらず、完了した後に実行されるアクションを定義できます。一般的な条件には、always、success、failure、changed、unstable があります。
例:
pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'ビルド中...'
}
}
}
post {
always {
echo 'パイプラインが終了しました。'
}
success {
echo 'パイプラインは成功しました！'
}
failure {
echo 'パイプラインは失敗しました。'
}
}
}
一般的なパイプライン構造とディレクティブ
基本を超えて、パイプラインはより高度な設定を必要とすることがよくあります。
環境変数
environment ディレクティブは、パイプライン内またはステージ内で使用できる環境変数を設定します。
例:
pipeline {
agent any
environment {
APP_NAME = 'my-awesome-app'
JAVA_HOME = '/usr/lib/jvm/java-11-openjdk-amd64'
}
stages {
stage('Build') {
steps {
echo "${env.APP_NAME}をビルド中"
sh 'echo $JAVA_HOME'
}
}
}
}
環境変数が env. プレフィックス（例: env.APP_NAME）を使用してアクセスされることに注意してください。
options ディレクティブ
options ディレクティブを使用すると、SCMのチェックアウトを無効にしたり、タイムアウトを設定したりするなど、さまざまなパイプライン固有の設定を構成できます。
例:
pipeline {
agent any
options {
timestamps()
timeout(time: 1, unit: 'HOURS')
disableConcurrentBuilds()
}
stages {
// ...
}
}
timestamps(): コンソール出力にタイムスタンプを追加します。timeout(): パイプライン全体にタイムアウトを設定します。disableConcurrentBuilds(): 同じパイプラインの複数のビルドが同時に実行されるのを防ぎます。
parameters ディレクティブ
このディレクティブを使用すると、パイプライン実行時にユーザーが提供できるパラメータを定義でき、パイプラインの柔軟性が向上します。
例:
pipeline {
agent any
parameters {
string(name: 'BRANCH_NAME', defaultValue: 'main', description: 'ビルドするブランチ')
booleanParam(name: 'TEST_ENABLED', defaultValue: true, description: 'テストを有効化または無効化')
}
stages {
stage('Checkout') {
steps {
echo "ブランチをチェックアウト中: ${params.BRANCH_NAME}"
// checkout scm
}
}
stage('Build') {
when {
expression { params.TEST_ENABLED == true }
}
steps {
echo 'テストを有効にしてビルドを実行中...'
// build steps
}
}
}
}
パラメータは params オブジェクト（例: params.BRANCH_NAME）経由でアクセスされます。
when ディレクティブ
when ディレクティブを使用すると、さまざまな基準に基づいてステージまたはステップを条件付きで実行できます。
例（ブランチ名を使用）:
stage('Deploy to Staging') {
when {
branch 'develop'
}
steps {
echo 'ステージング環境にデプロイ中...'
// deployment script
}
}
その他の when 条件には、expression、changelog、equals、allOf、anyOf、noneOf があります。
スクリプトパイプラインの基本（概要）
スクリプトパイプラインはGroovyで記述され、より命令的なプログラミングスタイルを提供します。宣言的パイプラインの厳格な構造はありませんが、究極の柔軟性を提供します。
例:
node {
stage('Build') {
echo 'ビルド中...'
sh 'mvn clean install'
}
stage('Test') {
echo 'テスト中...'
sh 'mvn test'
}
}
ここでは、node は agent に似ており、ステージは命令的に定義されます。スクリプトパイプラインは、スクリプトブロック内で pipeline {} を使用して、宣言的構文機能を取り込むこともできます。
Jenkinsパイプライン構文のベストプラクティス
- 単純さのために宣言的を使用: ほとんどの一般的なCI/CDワークフローでは、宣言的構文は読みやすさと保守性のために推奨されます。
- パイプラインをコードとして保存:
Jenkinsfileをアプリケーションコードと並行してソース管理リポジトリに保存します。 - 共有ライブラリを使用: 複雑または反復的なパイプラインロジックについては、再利用性と一貫性を促進するためにJenkins共有ライブラリの使用を検討してください。
- ステージのモジュール化: パイプラインを論理的で明確に定義されたステージに分割します。
- 失敗への優雅な対処: パイプラインが失敗した場合でもクリーンアップまたは通知が確実に発生するように、
postアクションを活用します。 - 機密情報の保護: ハードコーディングするのではなく、機密情報（パスワード、APIキー）にはJenkins資格情報管理を使用します。
- 賢明なパラメータ化: ビルド構成、デプロイターゲット、または変更される可能性のあるその他の変数に対してパラメータを使用します。
- すべてをバージョン管理:
Jenkinsfileをコードとして扱い、バージョン管理します。
結論
Jenkinsパイプライン構文、特に宣言的構文は、CI/CDプロセスを定義し自動化するための強力で柔軟な方法を提供します。pipeline、agent、stages、steps、post アクションなどのコアコンポーネントを理解することで、効果的なパイプラインの構築を開始できます。慣れてきたら、environment、options、parameters、when などのディレクティブを探求して、より洗練されたワークフローを作成してください。パイプラインが堅牢で、保守可能で、安全であることを確認するために、ベストプラクティスに従うことを忘れないでください。
ハッピーパイプライン！