Jenkins2 學(xué)習(xí)系列12 -- 創(chuàng)建和使用共享庫(kù)

當(dāng)有大量的pipeline項(xiàng)目構(gòu)建任務(wù),有很多代碼是重復(fù)的,這時(shí)需要提取和復(fù)用共同的邏輯无切。
其實(shí)pipeline本質(zhì)就是一個(gè)Groovy腳本,所以可以在pipeline中自定義函數(shù)丐枉,并使用Groovy語(yǔ)言自帶的特性哆键。
比如下面的Jenkinsfile,我們自定義了一個(gè) createVersion 函數(shù)瘦锹,并使用了內(nèi)置的Date類籍嘹。

pipeline {
    agent any
    
    stages {
        stage ('build') {
            steps {
                // 輸出 201907-4
                echo "${createVersion(BUILD_NUMBER)}"
            }
        }
    }
}

def createVersion(String BUILD_NUMBER) {
    return new Date().format('yyyyMM') + "-${BUILD_NUMBER}"
}

還有一種更優(yōu)雅的寫法,將變量定義在environment內(nèi)

pipeline {
    agent any
    
    environment {
       _version = createVersion()
    }
    
    stages {
        stage ('build') {
            steps {
                echo "${_version}"
            }
        }
    }
}

def createVersion() {
    return new Date().format('yyyyMM') + "-${env.BUILD_NUMBER}"
}

使用共享庫(kù)

大致流程:

  1. 新建個(gè)Groovy倉(cāng)庫(kù)弯院,里面包含共享庫(kù)代碼

這里已經(jīng)建好 jenkins-shared-library辱士,文件結(jié)構(gòu)如下:

image.png

vars 目錄下的全局變量可以直接在pipeline中使用,即當(dāng)寫sayHello('world')听绳,實(shí)際調(diào)用的是sayHello.groovy中的call函數(shù)

src 目錄是標(biāo)準(zhǔn)的Java源碼結(jié)構(gòu)颂碘,目錄中的類被稱為類庫(kù)(Library class),而 @Library('global-shared-library@master') 就是一次性靜態(tài)加載src目錄下所有代碼到classpath中椅挣。

src目錄中的類头岔,可以使用Groovy中的@Grab注解,自動(dòng)下載第三方依賴包

  1. Jenkins 管理后臺(tái)配置倉(cāng)庫(kù)地址和版本等
    進(jìn)入 Jenkins 的Manage Jenkins -> Configure System -> Global Pipeline Libraries 配置頁(yè)面
image.png
  1. Jenkins 項(xiàng)目的pipeline中引入共享庫(kù)(可以指定倉(cāng)庫(kù)版本和具體class)
    新建一pipeline類型的job鼠证。
    Pipeline內(nèi)容如下:
@Library('global-shared-library@master') _
pipeline {
    agent any
    
    environment {
       _version = createVersion()
    }
    
    stages {
        stage ('build') {
            steps {
                script {
                    def util = new com.mafeifan.Utils()
                    def version = util.createVersion("${BUILD_NUMBER}")
                    echo "${version}"
                    sayHello 'yes'
                    echo "${_version}"
                }
            }
        }
    }
}

def createVersion() {
    return new Date().format('yyyyMM') + "-${env.BUILD_NUMBER}"
}

查看構(gòu)建日志峡竣,發(fā)現(xiàn)Jenkins首先拉取共享庫(kù)代碼,執(zhí)行成功量九。

image.png

使用共享庫(kù)實(shí)現(xiàn)Pipeline模板

// vars/generatePipeline.groovy

def call(String lang) {
  if (lang == 'go') {
    pipeline {
      agent any
       stages {
         stage ('set go path') {
            steps {
               echo "GO path is ready"
            }
         }
       }
    } 
  } else if (lang == 'java') {
    pipeline {
      agent any
       stages {
         stage ('clean install') {
            steps {
               sh "mvn clean install"
            }
         }
       }
    } 
  }
  // 其他語(yǔ)言
}

使用時(shí)适掰,Jenkinsfile 只有兩行

@Library['global-shared-library'] _
generatePipeline('go')

如果大多數(shù)項(xiàng)目都是標(biāo)準(zhǔn)化的,可以利用共享庫(kù)的pipeline模塊技術(shù)來(lái)降低維護(hù)成本荠列。

這里只是拋磚引玉类浪,想寫出更強(qiáng)大的共享庫(kù)需要多了解Groovy。

優(yōu)先考慮使用自定義函數(shù)弯予,如果此函數(shù)出現(xiàn)在了至少三個(gè)項(xiàng)目中戚宦,考慮移到共享庫(kù)里,當(dāng)發(fā)現(xiàn)項(xiàng)目的pipeline非常相似锈嫩,考慮使用pipeline模塊受楼。

參考

https://jenkins.io/zh/doc/book/pipeline/shared-libraries/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末垦搬,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子艳汽,更是在濱河造成了極大的恐慌猴贰,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件河狐,死亡現(xiàn)場(chǎng)離奇詭異米绕,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)馋艺,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門栅干,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人捐祠,你說(shuō)我怎么就攤上這事碱鳞。” “怎么了踱蛀?”我有些...
    開封第一講書人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵窿给,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我率拒,道長(zhǎng)崩泡,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任猬膨,我火速辦了婚禮角撞,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘勃痴。我一直安慰自己靴寂,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開白布召耘。 她就那樣靜靜地躺著,像睡著了一般褐隆。 火紅的嫁衣襯著肌膚如雪污它。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,562評(píng)論 1 305
  • 那天庶弃,我揣著相機(jī)與錄音衫贬,去河邊找鬼。 笑死歇攻,一個(gè)胖子當(dāng)著我的面吹牛固惯,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播缴守,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼葬毫,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼镇辉!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起贴捡,我...
    開封第一講書人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤忽肛,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后烂斋,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體屹逛,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年汛骂,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了罕模。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡帘瞭,死狀恐怖淑掌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情图张,我是刑警寧澤锋拖,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布,位于F島的核電站祸轮,受9級(jí)特大地震影響兽埃,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜适袜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一柄错、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧苦酱,春花似錦售貌、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至扯饶,卻和暖如春恒削,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背尾序。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工钓丰, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人每币。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓携丁,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親兰怠。 傳聞我的和親對(duì)象是個(gè)殘疾皇子梦鉴,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355