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 更新中心发行的插件提供的步骤。
• 流水线示例，一个社区管理的可复制的流水线示例的集合。