pipeline-library

pipeline-library

自动化流水线全局库 Pipeline Global Library

Pipeline Global Library 是一个为 Jenkins 项目设计的流水线全局库,提供了一系列用于 Jenkins 实例的步骤和变量。该库包含构建 Maven 和 Gradle 插件项目的步骤,支持多平台并行构建,集成代码覆盖率和静态分析工具,并具备 Docker 镜像构建和发布功能。这个库简化和标准化了 Jenkins 项目的 CI/CD 流程,有助于提高开发效率。

JenkinsPipeline插件构建Docker镜像CI/CDGithub开源项目

= Pipeline Global Library for ci.jenkins.io

image:https://ci.jenkins.io/job/Infra/job/pipeline-library/job/master/badge/icon[link="https://ci.jenkins.io/job/Infra/job/pipeline-library/job/master/"] image:https://img.shields.io/github/v/release/jenkins-infra/pipeline-library[link="https://github.com/jenkins-infra/pipeline-library/releases"]

This repository contains a series of steps and variables for use inside of the Jenkins project's own link:https://ci.jenkins.io[Jenkins] instance(s).

Check link:https://github.com/jenkins-infra/documentation/blob/master/ci.adoc[this description] of available services.

== Useful steps:

=== buildPlugin

Applies the appropriate defaults for building a Maven-based plugin project on Linux and Windows.

You are advised to be using a link:https://github.com/jenkinsci/plugin-pom/blob/master/README.md[2.x or newer parent POM].

.Jenkinsfile [source,groovy]

buildPlugin( forkCount: '1C', // run this number of tests in parallel for faster feedback. If the number terminates with a 'C', the value will be multiplied by the number of available CPU cores useContainerAgent: true, // Set to false if you need to use Docker for containerized tests configurations: [ [platform: 'linux', jdk: 21], [platform: 'windows', jdk: 17], ])

==== Optional arguments

  • repo (default: null inherit from Multibranch) - custom Git repository to check out
  • useContainerAgent (default: false) - uses a link:https://github.com/jenkins-infra/documentation/blob/main/ci.adoc#container-agents[Container agent] instead of a Virtual Machine: usually faster to start and generates less costs for the project ** Please note that the implementation of "containers" can be changed over time
  • forkCount (default: null) - Execute tests with forkCount Java virtual machines. If no value is specified, a single JVM is used. Common values include 0.45C, 1, 2, and 1C. If you terminate the value with a 'C', that value will be multiplied by the number of available CPU cores. This controls the number of JVM's used for the test code. Additional JVM's will be launched if the test code starts agents or uses RealJenkinsRule.
  • failFast (default: true) - instruct Maven tests to fail fast
  • platforms (default: ['linux', 'windows']) - Labels matching platforms to execute the steps against in parallel
  • jdkVersions (default: [8]) - JDK version numbers, must match a version number jdk tool installed
  • jenkinsVersions: (default: [null]) - a matrix of Jenkins baseline versions to build/test against in parallel (null means default, only available for Maven projects)
  • configurations: An alternative way to specify platforms, jdkVersions and jenkinsVersions (that can not be combined with any of them).
  • useArtifactCachingProxy: (default: true) - if set to false, artifacts will not use one of the artifact caching proxy depending on the agent provider (Azure, DigitalOcean or AWS), and will directly use repo.jenkins-ci.org instead (discouraged as less reliable and consuming bandwidth)

** Those options will run the build for all combinations of their values. While that is desirable in many cases, configurations permit to provide a specific combinations of label and java/jenkins versions to use + [source,groovy]

buildPlugin(/.../, configurations: [ [ platform: "linux", jdk: "17", jenkins: null ], [ platform: "windows", jdk: "17", jenkins: null ], [ platform: "linux", jdk: "21", jenkins: "2.436" ] ])

NOTE: The recordIssues steps of the warnings plugin and the recordCoverage steps of the coverage plugin run on the first platform/jdkVersion,jenkinsVersion combination only. So in the example below it will run for linux/jdk11 but not on jdk17.

Usage:

.Jenkinsfile [source,groovy]

buildPlugin(platforms: ['linux'], jdkVersions: [11, 17], jacoco: [sourceCodeRetention: 'MODIFIED'], pit: [skip: false], checkstyle: [qualityGates: [[threshold: 1, type: 'NEW', unstable: true]]], pmd: [trendChartType: 'TOOLS_ONLY', qualityGates: [[threshold: 1, type: 'NEW', unstable: true]]])

=== buildPluginWithGradle()

Builds a Jenkins plugin using Gradle. The implementation follows the standard build/test/archive pattern. The method targets compatibility with link:https://github.com/jenkinsci/gradle-jpi-plugin[Gradle JPI Plugin], and it may not work for other use-cases.

==== Optional arguments

  • repo (default: null inherit from Multibranch) - custom Git repository to check out
  • failFast (default: true) - instruct the build to fail fast when one of the configurations fail
  • platforms (default: ['linux', 'windows']) - Labels matching platforms to execute the steps against in parallel
  • jdkVersions (default: [8]) - JDK version numbers, must match a version number jdk tool installed
  • configurations: An alternative way to specify platforms, jdkVersions (that can not be combined with any of them) ** Those options will run the build for all combinations of their values. While that is desirable in many cases, configurations permit to provide a specific combinations of label and java/jenkins versions to use

[source,groovy]

buildPluginWithGradle(/.../, configurations: [ [ platform: "linux", jdk: "8" ], [ platform: "windows", jdk: "8"], ])

==== Limitations

Not all features of buildPlugin() for Maven are supported in the gradle flow. Examples of not supported features:

=== infra.isTrusted()

Determine whether the Pipeline is executing in an internal "trusted" Jenkins environment

.Jenkinsfile [source,groovy]

if (infra.isTrusted()) { /* perform some trusted action like a deployment */ }

=== infra.ensureInNode(nodeLabels, body)

Ensures that the given code block is runs in a node with the specified labels

.Jenkinsfile [source,groovy]

infra.ensureInNode('docker,java') { sh 'docker -v' }

=== runBenchmarks

Runs JMH benchmarks and archives benchmark reports on highmem nodes.

Supported parameters:

artifacts:: (Optional) If artifacts is not null, invokes archiveArtifacts with the given string value.

==== Example

[source, groovy]

runBenchmarks('jmh-report.json')

=== buildDockerAndPublishImage(imageName, config)

Lints, Builds, then publishes a docker image.

Adds a bunch of build args you can use in your docker image:

  • GIT_COMMIT_REV - The commit that triggered this build
  • GIT_SCM_URL - Url to repo
  • BUILD_DATE - Date that the image was built (now)

Supported parameters:

imageName:: Name of the docker image to build

config:: (Optional) map of extra flags

  • agentLabels: String expression for the labels the agent must match
  • automaticSemanticVersioning: Do not automagically increase semantic version by default
  • includeImageNameInTag: Set to true for multiple semversioned images built in parallel, will include the image name in tag to avoid conflict
  • dockerfile: override the default dockerfile of Dockerfile
  • targetplatforms: defined the platforms to build as TARGET
  • nextVersionCommand: Commmand line used to retrieve the next version (default 'jx-release-version')
  • gitCredentials: override Credential ID for tagging and creating release
  • imageDir: Relative path to the context directory for the Docker build
  • registryNamespace: empty = autodiscover based on the current controller, but can override the smart default of jenkinsciinfra/ or jenkins4eval/
  • unstash: Allow to unstash files if not empty
  • dockerBakeFile: Allow to build from a bake file instead
  • dockerBakeTarget: Allow to specify a docker bake target other than 'default'
  • disablePublication: (Optional, default to false) Allow to disable tagging and publication of container image and GitHub release

==== Example [source, groovy]

buildDockerAndPublishImage('plugins-site-api') buildDockerAndPublishImage('inbound-agent-maven:jdk8-nanoserver', [ dockerfile: 'maven/jdk8/Dockerfile.nanoserver', agentLabels: 'docker-windows-2019 && amd64', targetplatforms: 'windows/amd64', imageDir: 'maven/jdk8', ])

is also called from parallelDockerUpdatecli with config within buildDockerConfig like this : [source, groovy]

parallelDockerUpdatecli([ imageName: 'wiki', rebuildImageOnPeriodicJob: false, updatecliConfig: [containerMemory: '1G'], buildDockerConfig : [targetplatforms: 'linux/amd64,linux/arm64,linux/s390x'] ])

== Contribute

=== Requirements

  • (Open)JDK v8
  • Maven 3.6.x

=== Testing a pull request

By adding @Library('pipeline-library@pull/<your-pr-number>/head') _ at the top of a Jenkinsfile from a repository built on one of the *.ci.jenkins.io instances, you can test your pipeline library pull request on ci.jenkins.io.

A repository is dedicated for these kind of tests: https://github.com/jenkinsci/jenkins-infra-test-plugin/

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多