从管道入门

如前所述以前,J必威国际有限公司enkins Pipeline是一套套件,支持实施和将连续送货管道集成到Jenkins中。管道提供可扩展的工具集,用于通过管道DSL建模简单到复杂的送货管“作为代码”。1

本节介绍如何开始在Jenkins中创建管道项目,并向您介绍某种方式必威国际有限公司必威国际有限公司Jenkinsfile.可以创建和存储。

先决条件

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

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

定义管道

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

Groovy语法的相关组件将根据本文档的要求引入,因此在对Groovy的理解有用时,它不需要与管道合作。

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

  • 通过蓝色海洋- 在蓝海中设置管道项目后,蓝色海洋UI可以帮助您编写管道必威国际有限公司Jenkinsfile.并提交给源控制。

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

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

与任何一种方法定义管道的语法是相同的,但是詹金斯支持直接进入经典UI进入管道,而且通常认为定义流水线的最佳做法必威国际有限公司必威国际有限公司Jenkinsfile.然后将哪个J必威国际有限公司enkins直接加载来自源控制。

通过蓝色海洋

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

作为在蓝色海洋中设置管道项目的一部分,Jenkins配置了与项目的源控制存储库的安全且适当地验证的连接。必威国际有限公司因此,你对的任何改变必威国际有限公司Jenkinsfile.通过蓝海的管道编辑器自动保存并提交到源代码控制。

阅读更多关于蓝海的更多信息蓝海章和蓝海开始页面。

通过经典的UI

一个必威国际有限公司Jenkinsfile.使用Classic UI创建由Jenkins本身存储(在Jenkins Home目录必威国际有限公司中)。

通过Jenkins Classic UI创建基本管道:必威国际有限公司

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

  2. 从Jenkins主必威国际有限公司页(即Jenkins Classic UI的仪表板),点击新物品在左上方。

    经典UI左列

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

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

    输入名称,单击<strong>管道</ strong>,然后单击<strong>确定</ strong>

  5. 点击管道页面顶部的选项卡以向下滚动到管道部分。
    笔记:如果相反,你定义你的必威国际有限公司Jenkinsfile.在源控制中,按照说明进行操作在供应链管理以下。

  6. 在里面管道部分,确保定义字段显示管道脚本选项。

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

    必威国际有限公司Jenkinsfile(声明式管道)
    管道{代理人(1)阶段{阶段(阶段1){步骤{echo你好世界!(2)}}}}}
    切换脚本管道 (先进的)
    1 代理人指示Jenkins在必威国际有限公司整个管道中分配executor(在Jenkins环境中的任何可用代理/节点上)和工作区。
    2 回声在控制台输出中写入简单的字符串。
    3. 节点有效地与之相同代理人(以上)。

    Classic UI中的示例流水线

    笔记:您也可以从罐头中进行选择脚本的管道示例尝试样品管道选项在右上角脚本文本区域。请注意,此字段中没有可用的封闭声明式管道示例。

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

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

    经典UI左列在项目上

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

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

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

    笔记:

    • 您还可以通过单击构建号左侧的彩色全球(例如,通过仪表板直接从仪表板上访问控制台输出(例如,#1).

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

在供应链管理

复杂的管道难以写入和维护经典UI脚本管道配置页面的文本区域。

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

配置管道项目以使用a必威国际有限公司Jenkinsfile.来自源码控制:

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

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

  3. 来自SCM.字段,选择包含您的存储库的源控制系统类型必威国际有限公司Jenkinsfile.

  4. 完成特定于存储库源控制系统的字段。
    提示:如果您不确定指定给定字段的值,请单击其有关更多信息的右侧的图标。

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

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

由于管道代码(特别是脚本化管道)以Groovy语法编写,如果您的IDE无法正确语法突出显示必威国际有限公司Jenkinsfile.,尝试插入行#!/ / usr / bin / env groovy在顶部必威国际有限公司Jenkinsfile.4foothegroovy_shebang:[谢邦线(Groovy语法)]这可能会纠正这个问题。

内置文档

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

内置文档可以在全球范围内找到$ {your必威国际有限公司_jenkins_url} / pipeline-syntax.同样的文档也被链接为管道语法在任何配置的管道项目的侧面栏中。

经典UI左列在项目上

代码生成器

内置的“代码段生成器”实用程序有助于为单个步骤创建代码位,发现由插件提供的新步骤,或尝试使用特定步骤的不同参数。

代码段生成器是用jenkins实例可用的步骤列表动态填充。必威国际有限公司可用的步数依赖于安装的插件,该插件明确公开了在管道中使用的步骤。

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

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

  2. 选择所需的步骤样本步骤下拉式菜单

  3. 控件下面的动态填充区域样本步骤下拉以配置所选步骤。

  4. 点击生成管道脚本创建一个可以复制和粘贴到管道的管道片段。

代码生成器

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

全局变量参考

除了仅曲面的片段发生器外,管道还提供内置的“全局变量参考。“与代码片生成器一样,它也是由插件动态填充的。与代码段发生器不同,全局变量引用仅包含文档变量由管道或插件提供,可用于管道。

默认在管道中提供的变量是:

env

暴露环境变量,例如:Env.Path.或者env.Build_id..请参阅内置全局变量参考$ {your必威国际有限公司_jenkins_url} / pipeline-syntax / globals #env有关完整,最新的,流水线中可用的环境变量列表。

参数个数

暴露为管道定义的所有参数作为只读地图, 例如:params.my_param_name.

CurrentBuild.

可用于发现有关当前执行管道的信息,属性如currentBuild.resultcurrentbuild.displayname.等。请参阅内置的全局变量参考$ {your必威国际有限公司_jenkins_url} / pipeline-syntax / globals有关完整,最新的,可用的属性列表CurrentBuild.

声明式指令发生器

虽然片段发电机有助于为脚本化管道的生成步骤或脚步块在A.阶段在陈述性管道中,它不会覆盖章节指令用于定义声明式管道。“声明式指令生成器”实用程序可以帮助解决这个问题。类似于代码生成器,指令生成器允许您选择声明性指令,以表单配置它,并为该指令生成配置,然后可以在声明性管道中使用该指令。

使用声明性指令生成的声明性指令:

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

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

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

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

指令生成器可以为嵌套指令生成配置,例如什么时候指令,但不能生成Pipeline步骤。包含步骤的指令的内容,例如脚步在一个阶段或情况一样总是或者失败里面帖子,指令生成器代替占位符评论。您仍然需要手动添加到您的管道的步骤。

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

进一步阅读

本节仅划伤了与Jenkins管道可以完成的内容,而是应该为您开始尝试使用测试Jenkins实例来提供足够的基础。必威国际有限公司

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

额外资源

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

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



此页面有用吗?

请通过此提交您关于此页面的反馈快速形式

或者,如果您不希望填写快速表格,您可以简单地指示您是否找到此页面有用吗?


查看现有的反馈这里