下面的插件通过与管道兼容的步骤提供可用的功能。有关如何将步骤集成到管道中的更多信息,请参见步骤部分管道的语法页。

有关其他此类插件的列表,请参阅管道步骤参考页。

管道:基本步骤

catchError:捕获错误并将构建结果设置为失败

如果主体抛出异常,则将构建标记为失败,但仍然继续从后面的语句执行PipelinecatchError步。抛出异常时的步骤的行为可以配置为打印消息,设置除了失败之外的构建结果,更改阶段结果,或忽略用于中断构建的某些类型的异常。

当在声明式管道中使用或与设置阶段结果或忽略构建中断的选项一起使用时,此步骤非常有用。否则,考虑使用普通格式尝试-( -最后)街区。当使用某些最初为自由式项目定义的构建后操作(通知程序)时,它也很有用,这些项目关注正在进行的构建的结果。

节点{catchError {sh'可能会失败'}步骤($ class:'mailer',收件人:'admin @ dewhere'])}

如果shell步骤失败,流水线构建的状态将设置为失败,因此后续邮件步骤将看到此构建失败。在邮件发件人的情况下,这意味着它将发送邮件。(如果这构建,它也可能发送邮件成功但是前面的步骤失败了,依此类推。)即使在这种情况下,这个步骤也可以用以下习惯用法代替:

node {try {sh 'might fail'} catch (err) {echo "Caught: ${err}" currentBuild。result = '失败'}step([$class: 'Mailer',收件人:'admin@somewhere'])}

对于其他情况,则为普通尝试-( -最后)可以使用块:

node {sh' ./ setup .sh' try {sh' might fail' echo 'Succeeded!'} catch (err) {echo "Failed: ${err}"} finally {sh' ./tear-down.sh'} echo '打印上面是否成功或失败。'} //…管道作为一个整体成功

本文件背景。

  • buildResult(可选的)
    如果捕获到错误,则总体生成结果将设置为此值。请注意,生成结果只会变得更糟,因此无法将结果更改为成功如果当前结果为不稳定或者更糟。使用成功无效的避免在捕获错误时设置构建结果。
    • 类型:细绳
  • 打断(可选的)
    如果为true,则该步骤将捕获并处理用于中断pipeline执行流的某些类型的异常。如果为false,这些类型的异常将被捕获并立即重新抛出。这些类型的异常示例包括通过UI手动中止构建时引发的异常,以及由暂停步。
    • 类型:布尔
  • 信息(可选的)
    如果捕获到错误,将记录到控制台的消息。如果指定了阶段结果,则消息也将与该结果相关联,并可能以可视化方式显示。
    • 类型:细绳
  • 阶段结果(可选的)
    如果捕捉到错误,阶段结果将设置为此值。如果指定了消息,则该消息将与此结果关联。使用成功无效的防止在捕获错误时设置舞台结果。
    • 类型:细绳

deletedir.:递归删除工作区的当前目录

递归地删除当前目录及其内容。符号链接和连接将不会被遵循,而是会被移除。要删除工作空间的特定目录,请将deletedir.步入A.谜语步。

    谜语:更改当前目录

    更改当前目录。任何一步进入谜语块将使用此目录作为当前,并且任何相对路径都将其作为基础路径使用。
    • 小路
      • 类型:细绳

    回声:打印消息

    • 信息
      • 类型:细绳

    错误:错误信号

    发出错误信号。如果要有条件地中止程序的某些部分,则此选项非常有用。你也可以抛出新的异常(),但此步骤将避免打印堆栈跟踪。
    • 信息
      • 类型:细绳

    fileExists:验证工作区中是否存在文件

    检查给定的文件(作为当前目录的相对路径)是否存在。返回真实|错误的
    • 文件
      相对(/-separated)路径到工作区中的文件,以验证其存在。
      • 类型:细绳

    Isunix.:检查是否在类unix节点上运行

    如果封闭则返回true节点在类Unix系统(如Linux或Mac OS X)上运行,如果是Windows,则为false。

      邮件: 邮件

      发送电子邮件的简单步骤。
      • 主题
        电子邮件主题行。
        • 类型:细绳
      • 身体
        电子邮件正文。
        • 类型:细绳
      • BCC.(可选的)
        密件抄送电子邮件地址列表。以逗号分隔的电子邮件地址列表。
        • 类型:细绳
      • CC.(可选的)
        抄送电子邮件地址列表。以逗号分隔的电子邮件地址列表。
        • 类型:细绳
      • Charset.(可选的)
        电子邮件正文字符编码。默认为UTF-8
        • 类型:细绳
      • (可选的)
        从电子邮件地址。默认为为Jenkins实例全局配置的管理地址。必威国际有限公司
        • 类型:细绳
      • mimetype.(可选的)
        电子邮件正文MIME类型。默认为文本/平原
        • 类型:细绳
      • 答复(可选的)
        Reploy-To电子邮件地址。默认为为Jenkins实例全局配置的管理地址。必威国际有限公司
        • 类型:细绳
      • (可选的)
        到电子邮件地址列表。逗号分隔的电子邮件地址列表。
        • 类型:细绳

      松材线虫病:确定当前目录

      将当前目录路径返回为字符串。
      • TMP.(可选的)
        如果选中,则返回与工作区关联的临时目录,而不是工作区本身。这是放置临时文件的适当位置,不应使源签出混乱;本地存储库或缓存;等
        • 类型:布尔

      readfile.:从工作区读取文件

      从相对路径(根目录在当前目录,通常是工作区)读取文件,并以普通字符串的形式返回其内容。
      • 文件
        相对(/- 在Workspace内的文件中的路径读取。
        • 类型:细绳
      • 编码(可选的)
        读取文件时要使用的编码。如果为空,将使用平台默认编码。二进制文件可以通过指定“Base64”作为编码来读入Base64编码的字符串。
        • 类型:细绳

      重试:重试主体最多N次

      如果在块体执行期间发生任何异常,请重试该块(最多N次)。如果在最后一次尝试时发生异常,那么它将导致构建中止(除非以某种方式捕获并处理它)。构建的用户中止是抓住了。
      • 数数
        • 类型:int

      睡觉: 睡觉

      只需暂停管道构建,直到给定的时间到期。相当于(在Unix上)“睡觉……”. 可用于暂停一个分支平行而另一个收益。
      • 时间
        该步要休眠的时间长度。
        • 类型:int
      • 单元(可选的)
        时间参数的单位。如果未指定,则默认为“秒”。
        • 价值观:纳秒微秒毫秒分钟小时

      :删除稍后在构建中使用的文件

      保存一组文件,以便以后在相同的Pipeline运行中的任何节点/工作区中使用。默认情况下,存储的文件在管道运行结束时被丢弃。其他插件可能会改变这种行为,以延长存储时间。例如,声明式管道包括蜜饯贮藏如果重新启动该运行,则选项以允许从运行中删除并使用填充物。
      一个管道运行中的存储在其他运行、其他管道或其他作业中不可用。如果您想要持久化工件以便在一次运行之外使用,请考虑使用archiveArtifacts反而。笔记卸下步骤设计用于小文件。对于大数据传输,请使用外部工作区管理器插件,或使用外部存储库管理库,如Nexus或Nexus或ar​​tifactory。这是因为陷入困境的文件在压缩的tar中存档,并且具有大文件,这需要相当大的主资源,特别是CPU时间。没有硬藏尺寸限制,但在5-100 MB之间,您应该考虑替代方案。
      • 名称
        藏匿的名字。应该是一个简单的标识符,类似于作业名称。
        • 类型:细绳
      • Quallempty.(可选的)
        • 类型:布尔
      • 不包括(可选的)
        可选的ant是基于排除模式
        使用逗号分隔的列表添加多个表达式。
        如果为空,则不会排除任何文件。
        • 类型:细绳
      • 包括(可选的)
        可选的蚂蚁风格包括模式
        使用逗号分隔的列表添加多个表达式。
        如果是空白,请视为**: 所有文件。
        当前工作目录是已保存文件的基本目录,稍后将在相同的相对位置还原这些文件,因此如果要使用子目录,请将其打包谜语
        • 类型:细绳
      • useDefaultExcludes(可选的)
        如果选中,请使用默认的“从Ant排除”-请参见在这里的列表。
        • 类型:布尔

      一步:通用构建步骤

      这是一个特殊的步骤,允许调用Builders或Build-Build操作(如Freestyle或类似项目),通常是“构建步骤”。只需选择从下拉列表调用的构建步骤并根据需要配置它。

      请注意,列表中只显示与管道兼容的步骤。

      要使用此步骤,您需要指定一个委托类,例如步骤([$class:'A3Builder']))

      暂停:强制执行时间限制

      以确定的超时限制在块内执行代码。如果达到时间限制,将抛出异常(org.jenkinsci.plugins.workflow.steps.FlowInterruptedException),这将导致中止构建(除非以某种方式捕获和处理)。必威国际有限公司
      • 时间
        在取消嵌套块之前,此步骤将等待的时间长度。
        • 类型:int
      • 活动(可选的)
        在该块的日志中没有活动之后的超时而不是绝对持续时间。
        • 类型:布尔
      • 单元(可选的)
        时间参数的单位。如果未指定,则默认为“分钟”。
        • 价值观:纳秒微秒毫秒分钟小时

      工具:使用预定义工具安装中的工具

      将工具安装绑定到变量(返回工具主目录)。仅限已在中配置的工具配置系统在这里可以买到。如果原始工具安装程序具有自动配置功能,则将根据需要安装该工具。
      • 名称
        • 类型:细绳
      • 类型(可选的)
        • 类型:细绳

      不稳定:设置阶段结果不稳定

      将消息打印到日志中,并设置整体构建结果和阶段结果不稳定. 该消息还将与阶段结果关联,并可能以可视化方式显示。
      • 信息
        将记录到控制台的消息。该消息还将与阶段结果相关联,并且可以在可视化中显示。
        • 类型:细绳

      卸下:还原以前隐藏的文件

      还原以前的一组文件Ed进入当前工作区。
      • 名称
        以前保存的存储的名称。
        • 类型:细绳

      waitUntil:等待条件

      重复运行其主体,直到其返回真的。如果返回错误的,请稍等片刻,然后重试(随后的失败将使两次尝试之间的延迟降低,最长可达15秒。)重试次数没有限制,但如果主体抛出一个立即抛出的错误。
      • initialRecurrencePeriod(可选的)
        在重试之间设置初始等待句数,以毫秒为单位。默认为250ms。
        每次故障都会使两次尝试之间的延迟降低,最长可达15秒。
        • 类型:长的
      • 安静的(可选的)
        如果为true,则每次检查条件时,步骤都不会记录消息。默认为false。
        • 类型:布尔

      警告错误:捕获错误并将构建和阶段结果设置为不稳定

      执行其主体,如果抛出异常,则将总体构建结果和阶段结果设置为不稳定,将指定的消息和抛出的异常打印到构建日志中,并将阶段结果与消息关联起来,以便可以通过可视化方式显示。

      相当于catchError(message: message, buildResult: '不稳定',stageResult: '不稳定')

      • 信息
        如果发现错误,将记录到控制台的消息。该消息还将与阶段结果关联,并可能以可视化方式显示。
        • 类型:细绳
      • 打断(可选的)
        如果为true,则该步骤将捕获并处理用于中断pipeline执行流的某些类型的异常。如果为false,这些类型的异常将被捕获并立即重新抛出。这些类型的异常示例包括通过UI手动中止构建时引发的异常,以及由暂停步。
        • 类型:布尔

      withEnv:设置环境变量

      设置块内的一个或多个环境变量。这些对该范围内产生的任何外部进程都可用。例如:

      ['MYTOOL_HOME=/usr/local/mytool']) {sh '$MYTOOL_HOME/bin/start'}}

      (注意,这里我们在Groovy中使用了单引号,所以变量扩展是由Bourne shell完成的,而不是Jenkins。)必威国际有限公司

      查看文档env.有关环境变量的更多信息。

      • 覆盖
        要设置的环境变量列表,每个变量的形式如下变量=值变量=取消设置其他定义的变量。您也可以使用语法PATH+WHATEVER=/something要预先考虑/东西$途径
        • 类型:数组/列表细绳

      :通用生成包装器

      这是一个特殊的步骤,允许调用构建包装器(在freestyle或类似的项目中也称为“Environment Configuration”)。只需从下拉列表中选择要使用的包装器,并根据需要配置它。包装器块中的所有内容都受其影响。

      请注意,只有管道兼容的包装器将在列表中显示。

      要使用此步骤,您需要指定一个委托类,例如包装([$class:'AnsiColorBuildWrapper']))

      写文件:将文件写入工作区

      将给定内容写入当前目录中的命名文件。
      • 文件
        • 类型:细绳
      • 文本
        • 类型:细绳
      • 编码(可选的)
        文件编码的目标。如果为空,将使用平台默认编码。如果文本是Base64编码的字符串,则可以通过将“base64”指定为编码来将解码的二进制数据写入文件。
        • 类型:细绳

      存档:档案工件

      归档构建输出工件以供以后使用。截至Jenk必威国际有限公司ins 2.x,此步骤已弃用,支持更可配置的archiveArtifacts
      • 包括
        包括与此匹配的工件蚂蚁风格模式。使用逗号分隔的列表添加多个表达式。
        • 类型:细绳
      • 不包括(可选的)
        排除与此匹配的工件蚂蚁式模式
        使用逗号分隔的列表添加多个表达式。
        • 类型:细绳

      getContext:从内部api获取上下文对象

      获取上下文对象,如中所示StepContext.get; 查阅含有文本. 单程旅行类型争论。例子:

      getcontext hudson.filepath.

      用于可操作内部Jenkins API的受信任代码,如全局库。必威国际有限公司

      • 类型
        • 类型:. lang . class < ?>

      无归档:将归档的工件复制到工作区中

      • 映射(可选的)
        • 类型:java.util.Map

      含有文本:使用块内部api中的上下文对象

      在上下文对象中换行块,如中所示BodyInVoker.WithContext.; 查阅getContext. 单程旅行语境参数加一个块。例子:

      withContext(new MyConsoleLogFilter()) {sh 'process'}

      在案例中自动使用上下文对象合并其参数控制台过滤器LauncherDecorator,及环境保护者

      用于可操作内部Jenkins API的受信任代码,如全局库。必威国际有限公司

      尝试传递在Groovy中定义的对象;只支持java定义的对象。你真的应该避免使用这个和getContext并只是定义一个而是在一个插件中。

      • 语境
        • 类型:对象

      这个页面有用吗?

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

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


      看到现有的反馈在这里