jenkins流水線(pipeline)基本使用

正如?前文?提到的，Jenkins 流水線是一套插件，它支持實現和集成持續交付流水線到 Jenkins。流水線提供了一組可擴展的工具，用于通過流水線 DSL 將簡單到復雜的交付流水線建模為“代碼”。

本節描述了如何在 Jenkins 中開始創建你的流水線并介紹創建和存儲?Jenkinsfile?的各種方式。

配置要求

為了使用 Jenkins 流水線，你需要：

• Jenkins 2.x 或以上版本（舊版本到 1.642.3 可能可以，但不建議）
• 流水線插件，[2]?作為“建議插件”的一部分安裝（在安裝 Jenkins 后，運行 Post-installation setup wizard 時指定）。

定義流水線

• 通過 Blue Ocean?- 在 Blue Ocean 中設置一個流水線項目后，Blue Ocean UI 會幫你編寫流水線的?Jenkinsfile?文件并提交到源代碼管理系統。
• 通過經典 UI - 你可以通過經典 UI 在 Jenkins 中直接輸入基本的流水線。
• 在源碼管理系統中定義?- 你可以手動編寫一個?Jenkinsfile?文件，然后提交到項目的源代碼管理倉庫中。[3]

通過 Blue Ocean

通過經典 UI

1. 如果有要求的話，確保你已登錄進 Jenkins。
2. 從Jenkins 主頁（即 Jenkins 經典 UI 的工作臺），點擊左上的?新建任務。

   

   ?

   
   
3. 在?輸入一個任務名稱字段，填寫你新建的流水線項目的名稱。
   警告：Jenkins 使用這個項目名稱在磁盤上創建目錄。建議不要在項目名稱中使用空格，因為這樣做可能會觸發在腳本中不能正確處理目錄路徑中的空格的bug。
4. 向下滾動并點擊?流水線，然后點擊頁面底部的?確定?打開流水線配置頁（已選中?General?選項）。

   ?

   
   
5. 點擊頁面頂部的?流水線?選項卡讓頁面向下滾動到?流水線?部分。
   注意：如果你在源代碼管理系統中定義了?Jenkinsfile， 請按照下面的在源碼管理系統中定義的說明。
6. 在?流水線?部分, 確保?定義?字段顯示?Pipeline script?選項。
7. 將你的流水線代碼輸入到?腳本?文本區域。
   例如，復制并粘貼下面的聲明式示例流水線代碼（在?Jenkinsfile ( … )?標題下）或者它的腳本化的版本到?腳本?文本區域。（下面的聲明式示例將在整個過程的其余部分使用。）

   Jenkinsfile (Declarative Pipeline)
   Toggle Scripted Pipeline?(Advanced)

   	agent?指示 Jenkins 為整個流水線分配一個執行器（在 Jenkins 環境中的任何可用代理/節點上）和工作區。
   	echo?寫一個簡單的字符串到控制臺輸出。
   	node?與上面的?agent?做了同樣的事情。

   
   

   注意：你也可以從?腳本?文本區域右上方的?try sample Pipeline…?選項選擇腳本式流水線的示例。注意該區域沒有可用的聲明式流水線示例。

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

1. 
   
9. 點擊?保存?打開流水線項目視圖頁面。
10. 在該頁面, 點擊左側的?立即構建?運行流水線。

    
    
11. 

    在左側的?Build History?下面，點擊?#1?來訪問這個特定流水線運行的詳細信息。

    ?
12. 點擊?Console Output?來查看流水線運行的全部輸出。下面的輸出顯示你的流水線已成功運行。

    ?

    
    

    注意：

• 你也可以通過點擊構建號左邊的彩色地球儀從工作臺直接訪問控制臺輸出（例如?#1）。
• 通過經典的 UI 定義流水線可以很方便的測試流水線代碼片段，也可以處理簡單的或不需要從源代碼倉庫中檢出/克隆的流水線。正如上面提到的，和通過 Blue Ocean（上面）或在版本管理系統中（下面）定義的 ``Jenkinsfile`` 不同，在流水線項目的?腳本?文本區域輸入的 ``Jenkinsfile`` 由 Jenkins 自己存儲在 Jenkins 主目錄下。因此，為了更好地控制和擴展你的流水線，尤其是源代碼管理系統中那些復雜的項目，建議使用 Blue Ocean 或?源碼管理系統來定義你的?Jenkinsfile?文件。

在源碼管理系統中

1. 按照?通過經典 UI上面的步驟定義你的流水線直到第5步（在流水線配置頁面訪問流水線部分）。
2. 從?定義?字段選擇?Pipeline script from SCM?選項。
3. 從?SCM?字段，選擇包含?Jenkinsfile?文件的倉庫的源代碼管理系統的類型。
4. 填充對應倉庫的源代碼管理系統的字段。
   Tip:?如果你不確定給定字段應填寫什么值，點擊它右側的???圖標以獲取更多信息。
5. 在?腳本路徑?字段，指定你的?Jenkinsfile?文件的位置（和名稱）。這個位置是 Jenkins 檢出/克隆包括?Jenkinsfile?文件的倉庫的位置，它應該與倉庫的文件結構匹配。該字段的默認值采取名稱為 "Jenkinsfile" 的?Jenkinsfile?文件并位于倉庫的根路徑。

內置文檔

片段生成器

1. 從已配置好的流水線導航到?流水線語法?鏈接（見上），或訪問 ``${YOUR_JENKINS_URL}/pipeline-syntax``。
2. 在?示例步驟?下拉菜單中選擇需要的步驟。
3. 使用?示例步驟?下拉菜單的動態填充區來配置已選的步驟。
4. 點擊?生成流水線腳本?生成一個能夠被復制并粘貼到流水線中的流水線片段。

   ?

全局變量參考

env

params

currentBuild

聲明式指令生成器

1. 從已配置好的流水線導航到?Pipeline Syntax/流水線語法?鏈接（見上），然后點擊側欄的?Declarative Directive Generator，或直接訪問 ``${YOUR_JENKINS_URL}/directive-generator``。
2. 在下拉菜單中選擇需要的指令。
3. 使用下拉菜單下面動態生成的區域配置已選的指令。
4. 點擊?Generate Declarative Directive?生成一個能夠被復制到流水線中的指令配置。

stage('Stage 1') {
    steps {
        // One or more steps need to be included within the steps block.
    }
}

延伸閱讀

其它資源

• 流水線步驟參考，圍繞著所有在 Jenkins 更新中心發行的插件提供的步驟。
• 流水線示例，一個社區管理的可復制的流水線示例的集合。