开始使用管道

如上所述以前, 必威国际有限公司Jenkins Pipeline是一套插件,支持实现和集成持续交付管道到Jenkins。Pipeline提供了一组可扩展的工具,用于通过Pipeline DSL“以代码的形式”对简单到复杂的交付管道进行建模。1

这一节描述了如何开始在Jenkins中创建你的管道项目,并介绍了各种方法必威国际有限公司必威国际有限公司Jenkinsfile可以创建和存储。

先决条件

要使用Jenk必威国际有限公司ins Pipeline,你需要:

阅读更多关于如何安装和管理插件管理插件

定义管道

这两个声明式和脚本化的管道是DSL吗1描述软件交付管道的一部分。脚本管道以有限的形式编写Groovy的语法

本文档将根据需要介绍Groovy语法的相关组件,因此尽管理解Groovy很有帮助,但不需要使用管道。

管道可以通过以下方式之一创建:

  • 通过蓝色海洋-在Blue Ocean中设置管道项目后,Blue Ocean UI将帮助您编写管道的必威国际有限公司Jenkinsfile并将其提交给源代码管理。

  • 通过经典的UI-你可以通过经典的UI直接在Jenkins中输入一个基本的管道。必威国际有限公司

  • 在供应链管理-你可以写a必威国际有限公司Jenkinsfile手动,您可以提交到项目的源代码控制存储库。3.

使用任何一种方法定义管道的语法都是相同的,但尽管Jenkins支持将管道直接输入到经典UI中,但通常认为在必威国际有限公司必威国际有限公司Jenkinsfile然后Jenk必威国际有限公司ins将直接从源代码管理加载。

通过蓝色海洋

如果你是Jenkins Pipeli必威国际有限公司ne的新手,蓝海UI可以帮助你设置您的管道项目,并自动创建和写入管道(即必威国际有限公司Jenkinsfile),通过图形化的管道编辑器。

作为在Blue Ocean中设置管道项目的一部分,Jenkins配置一个安全的、经过适当身份验证的连接到项目的源代码控必威国际有限公司制存储库。因此,您对必威国际有限公司Jenkinsfile通过蓝海的管道编辑器自动保存并提交到源代码控制。

阅读更多关于蓝色海洋的文章蓝色海洋章及从蓝海开始页面。

通过经典的UI

一个必威国际有限公司Jenkinsfile由Jenkins本身存储(在Jenkins主目录中)。必威国际有限公司

要通过Jenkins classic UI创建基本管道,请执行以下操作:必威国际有限公司

  1. 如果需要,确保您已登录到Jenkins。必威国际有限公司

  2. 从Jenkins主必威国际有限公司页(即Jenkins classic UI的仪表板),单击新项目在左上方。

    经典UI左列

  3. 输入项目名称字段,指定新管道项目的名称。
    警告:必威国际有限公司Jenkins使用这个项目名在磁盘上创建目录。建议避免在项目名称中使用空格,因为这样做可能会发现脚本中的错误,这些错误不能正确处理目录路径中的空格。

  4. 向下滚动,点击管道,然后单击好啊在页面的末尾打开管道配置页面(其一般选项卡被选中)。

    输入名称,单击管道,然后单击确定

  5. 单击管道选项卡,向下滚动至管道部分。
    注:如果相反,你定义你的必威国际有限公司Jenkinsfile在源代码控制中,请遵循在供应链管理在下面。

  6. 管道第节,确保定义字段显示管道的脚本选择。

  7. 将管道代码输入脚本文本区域。
    例如,复制以下声明性示例管道代码(位于必威国际有限公司詹金斯档案(…)标题)或等效的脚本版本,并将其粘贴到脚本文本区域。(下面的声明性示例将在整个过程中使用。)

    必威国际有限公司Jenkinsfile(声明式管道)
    管道{代理任何(1)阶段{阶段(第一阶段){步骤{回音你好世界!(2)} } } }
    切换脚本管道 (高级)
    1 代理人指示Jenkins为必威国际有限公司整个Pipeline分配一个执行器(在Jenkins环境中任何可用的代理/节点上)和工作区。
    2 回声在控制台输出中写入简单字符串。
    3. 节点实际上,这与代理人(见上图)。

    经典UI中的示例管道

    注:你也可以选择罐装的脚本的管道示例尝试样本管道选项的右上角脚本文本区域。请注意,此字段中没有可用的封闭声明式管道示例。

  8. 点击拯救打开管道项目/项目视图页面。

  9. 在这个页面上,单击立即建造,以运行管道。

    经典的UI左列

  10. 在下面建立历史在左侧单击#1访问此特定管道运行的详细信息。

  11. 点击控制台输出查看管道运行的完整输出。以下输出显示管道的成功运行。

    <strong>控制台输出</strong>的管道

    注:

    • 你也可以通过点击构建号左边的彩色地球仪直接从仪表板访问控制台输出。#1).

    • 通过经典UI定义管道对于测试管道代码段或处理简单的管道或不需要从存储库检出/克隆源代码的管道都很方便。如上所述,不像必威国际有限公司Jenkinsfile你通过蓝海(在上面)或在源代码控制(在下面),必威国际有限公司Jenkinsfile他参加了比赛脚本管道项目的文本区域由Jenkins本身存储在Jenkins主目录中。必威国际有限公司因此,为了对您的Pipeline进行更大的控制和灵活性,特别是对于可能增加复杂性的源代码控制项目,建议您使用它蓝色海洋源代码控制定义你的必威国际有限公司Jenkinsfile

在供应链管理

复杂的管道难于编写和维护典型的用户界面脚本管道配置页面的文本区域。

为了使这更容易,您的管道必威国际有限公司Jenkinsfile可以在文本编辑器或集成开发环境(IDE)中编写,并致力于源代码控制3.(可选使用Jenkins将构建的应用程序代码)。Jenkins然后可以查看您的必威国际有限公司必威国际有限公司Jenkinsfile将源代码管理作为管道项目构建过程的一部分,然后继续执行管道。

要将管道项目配置为使用必威国际有限公司Jenkinsfile源代码管理:

  1. 按照上面的过程定义管道通过经典的UI直到达到步骤5(访问管道部分)。

  2. 定义字段中,选择来自SCM的管道脚本选择。

  3. 供应链管理字段,选择包含您的存储库的源代码控制系统类型必威国际有限公司Jenkinsfile

  4. 填写特定于存储库源代码管理系统的字段。
    提示:如果您不确定要为给定字段指定什么值,请单击其图标,以了解更多信息。

  5. 脚本的路径字段,指定您的必威国际有限公司Jenkinsfile.这个位置是詹金斯签出/克隆存储库包含你的必威国际有限公司必威国际有限公司Jenkinsfile,它应该与存储库的文件结构相匹配。该字段的默认值假设您的必威国际有限公司Jenkinsfile名为“Jenkins必威国际有限公司file”,位于存储库的根目录。

当您更新指定的存储库时,只要管道配置了SCM轮询触发器,就会触发一个新的构建。

由于管道代码(特别是脚本管道)是用类似Groovy的语法编写的,如果您的IDE没有正确地语法突出显示必威国际有限公司Jenkinsfile,尝试插入该行#!/usr/bin/env groovy在顶部必威国际有限公司Jenkinsfile4脚注(u shebang):[Shebang行(Groovy语法)]这可能会纠正这个问题。

内置文档

Pipeline附带了内置的文档特性,从而更容易创建不同复杂性的管道。这个内置文档是根据安装在Jenkins实例中的插件自动生成和更新的。必威国际有限公司

内置的文档可以在全局上找到${YOUR_必威国际有限公司JENKINS_URL}/pipeline语法.同样的文档也被链接为管道的语法在任何已配置管道项目的侧栏中。

经典的UI左列

代码生成器

内置的“Snippet Generator”实用程序有助于为各个步骤创建代码位,发现插件提供的新步骤,或为特定步骤试验不同的参数。

代码段生成器动态填充Jenkins实例可用的步骤列表。可用步骤的数量取决于所安装的插件,这些插件显式公开了在管道中使用的步骤。必威国际有限公司

使用snippet Generator生成步骤代码片段:

  1. 导航到管道的语法链接(上面引用过)从已配置的管道,或${YOUR_必威国际有限公司JENKINS_URL}/pipeline语法

  2. 中选择所需的步骤示例步骤下拉菜单

  3. 控件下面的动态填充区域示例步骤下拉菜单配置所选步骤。

  4. 点击生成管道脚本创建可复制并粘贴到管道中的管道代码段。

代码生成器

要访问有关所选步骤的其他信息和/或文档,请单击帮助图标(由上图中的红色箭头指示)。

全局变量引用

除了Snippet Generator(它只显示步骤)之外,Pipeline还提供了一个内置的“全局变量引用“与代码段生成器一样,它也由插件动态填充。但是,与代码段生成器不同,全局变量引用仅包含变量由管道或插件提供,可用于管道。

默认情况下,管道中提供的变量是:

env

公开环境变量,例如:环境路径env.BUILD\u ID.请参阅内置全局变量的引用${YOUR_必威国际有限公司JENKINS_URL}/pipeline syntax/globals#env查看完整的、最新的管道中可用的环境变量列表。

参数个数

将为管道定义的所有参数公开为只读参数地图,例如:params.MY_PARAM_NAME

当前版本

可用于发现有关当前正在执行的管道的信息,其属性如下currentBuild.resultcurrentBuild.displayName,等。请参阅$ {YOUR必威国际有限公司_JENKINS_URL} / pipeline-syntax /全局有关上提供的完整且最新的属性列表,请参见当前版本

声明式指令发生器

而Snippet Generator则帮助为脚本化管道或台阶块在一个阶段在声明性管道中,它不包括部分指令用于定义声明式管道。“声明式指令生成器”实用程序可以帮助解决这个问题。类似于代码生成器,指令生成器允许您选择一个声明性指令,在表单中对其进行配置,并生成该指令的配置,然后在声明性管道中使用该配置。

使用声明式指令生成器生成声明式指令:

  1. 导航到管道的语法链接(上面引用过),然后单击声明式指令发生器链接在侧板,或直接到$ {YOUR必威国际有限公司_JENKINS_URL} / directive-generator

  2. 在下拉菜单中选择所需的指令

  3. 使用下拉列表下的动态填充区域来配置所选指令。

  4. 点击生成指令来创建指令的配置并复制到您的管道中。

指令生成器可以为嵌套指令生成配置,例如指令,但不能生成Pipeline步骤。包含步骤的指令的内容,例如台阶在一个阶段或条件总是失败在…内帖子,指令生成器将添加占位符注释。您仍需要手动将步骤添加到管道中。

必威国际有限公司Jenkinsfile(声明式管道)
舞台(第一阶段){步骤{//步骤块中需要包含一个或多个步骤。} }

进一步的阅读

这一部分只是划破了詹金斯管道所能做的事情,但是应该为您提供足够的基础来开始测试一个测试詹金斯实例。必威国际有限公司

在下一节中,的Jen必威国际有限公司kinsfile,我们将讨论更多的管道步骤,以及实现成功的、真实的Jenkins管道的模式。必威国际有限公司

额外资源

  • 管道步骤参考,包含了Jenkins更新中心中发布的插件所提供的所有步骤。必威国际有限公司

  • 管道的例子,社区策划的可复制管道示例集合。



这个页面有用吗?

请通过这个提交你对这个页面的反馈快速形成

或者,如果您不希望完成快速表单,您可以简单地指出,如果您觉得这个页面有帮助?


看到现有的反馈在这里