g자꾸 Declarative와 Scripted가 뭐고 헷갈려서 정리용으로 씁니다.. 하지만 둘의 차이점을 다루기 보다는 이 글에선 Declarative 문법에 대해서 다룹니다.

파이프라인 구조

예시

예시1

pipeline {
    agent any 
    stages {
        stage('Stage 1') {
            steps {
                echo 'Hello world!' 
            }
        }
    }
}

1. pipeline : 젠킨스 파이프라인 플러그인을 호출하기 위한 필수 외부 블록

2. agent : 파이프라인을 실행하고 싶은 위치 정의any : 파이프라인이나 스테이지를 실행하기 위해 사용가능한 어느 agent도 사용 할 수 있음 정의

3. echo : 간단한 console output 을 찍을 수 있다.

4. stages : stage의 모음

5. steps : 실제 작업 수행하는 블록

6. 세미콜론은 없습니다

예시2

• post : 파이프라인 실행 또는 스테이지 끝에 실행될 동작을 정의(always, changed, failure, success, unstable, aborted)

pipeline {
    agent any

    stages {
        stage('build') {
            steps {
                sh 'build check'
            }
        }
    }

    post {
        always {
            junit '**/target/*.xml'
        }
        failure {
            mail to: team@gmail.com, subject: 'Pipeline fail email'
        }
    }
}

---

섹션

agent : 젠킨스잡을 실행할 agent

post : 특정 스테이지 이전 혹은 이후에 실행될 condition block

pipeline {
    agent any
    stages {
        stage('Hello') {
            steps {
                echo 'Hello World'
            }
        }
    }
    post { 
        always { 
            echo 'It's Nice to meet youuuuuuu'
        }
    }
}

stages : 스테이지들을 모아놓은곳

pipeline {
    agent any
    stages { 
        stage('Example') {
            steps {
                echo 'Hello World'
            }
        }
    }
}

steps : 각 stage 내부블록에서 여러번 선언할 수 있는 블록

---

Directives

enviroment : key-value style로 파이프라인 내부에서 사용할 변수로 선언 가능

pipeline {
    agent any
    environment { 
        Name = 'Geonhyeon'
    }
    stages {
        stage('Checkout') {
            environment { 
                PAT_TOKEN = credentials('my-git-token') 
            }
            steps {
                sh 'printenv'
            }
        }
    }
}

options : pipeline의 옵션을 삽입 가능

사용가능한 옵션들

• buildDiscarder : Persist artifacts and console output for the specific number of recent Pipeline runs

• disableConcurrentBuilds : Disallow concurrent executions of the Pipeline. Can be useful for preventing simultaneous accesses to shared resources, etc

• overrideIndexTriggers : Allows overriding default treatment of branch indexing triggers

• skipDefaultCheckout : Skip checking out code from source control by default in the agent directive

• skipStagesAfterUnstable : Skip stages once the build status has gone to UNSTABLE

• checkoutToSubdirectory : Perform the automatic source control checkout in a subdirectory of the workspace

• timeout : Set a timeout period for the Pipeline run, after which Jenkins should abort the Pipeline

• retry : On failure, retry the entire Pipeline the specified number of times

• timestamps : Prepend all console output generated by the Pipeline run with the time at which the line was emitted

pipeline {
    agent any
    options {
        timeout(time: 1, unit: 'HOURS') 
    }
    stages {
        stage('Example') {
            steps {
                echo 'Hello World'
            }
        }
    }
}

parameteres : 유저로부터 트리거링 받은 변수들에 대해서 선언할 수 있다.

• String : A parameter of a string type, for example: parameters { string(name: 'DEPLOY_ENV', defaultValue: 'staging', description: '') }

• booleanParam : A boolean parameter, for example: parameters { booleanParam(name: 'DEBUG_BUILD', defaultValue: true, description: '') }

triggers : cront, pollSCM, upstream 등 여러방식으로 트리거를 구성할 수 있다.

---

환경변수

1. env관련 환경변수 (env.로 접근)

env 환경 변수는 다음과 같은 형식 env.VARNAME으로 참조될 수 있다. 대표적인 env의 property는 아래와 같다.

2. currentBuild

currentBuild 변수는 RunWrapper 타입입니다. 현재 진행중인 빌드를 참고하는 데 사용됩니다.

이것은, 읽는게 가능한 아래의 property들을 가지고 있습니다. currentBuild로 접근 가능.