Jenkins pipeline共享库的最佳实践

Jenkins 共享库使用教程

Jenkins 共享库（Shared Libraries）是一个功能强大的工具，旨在帮助团队在多个 Jenkins 项目中重用代码。这使得 CI/CD 流水线能够更加高效、简洁，并减少重复劳动。通过共享库，你可以将常用的 Groovy 脚本、步骤、函数等提取到一个公共的位置，使得多个项目都能引用它们。

1. 什么是 Jenkins 共享库？

Jenkins 共享库是一个包含可以在多个 Jenkins 作业中共享和重用的步骤、函数、类等代码的仓库。它允许你将重复的流水线代码、构建、部署脚本等抽象化为库，以便多个流水线使用。

2. 共享库的基本结构

共享库通常有以下基本结构：

(root)
├── src/
│    └── org/
│         └── foo/
│              └── MyClass.groovy
├── vars/
│    └── myPipelineStep.groovy
├── resources/
│    └── myTemplate.txt
├── README.md
└── Jenkinsfile

• src/: 存放 Groovy 类，通常用来封装一些业务逻辑或工具函数。
• vars/: 存放可以在 Jenkinsfile 中直接调用的全局变量或步骤。这些是共享库的主要入口。
• resources/: 存放模板文件或静态文件，如配置文件、脚本等。
• Jenkinsfile: 定义了共享库的基本配置及说明。

3. 创建和配置共享库

3.1 在 Git 仓库中创建共享库

共享库通常托管在 Git 仓库中，你可以选择任何 Git 托管平台，如 GitHub、GitLab、Bitbucket 等。创建一个新的 Git 仓库，并为其提供共享库的基本结构。

例如，在 GitHub 创建一个名为 my-shared-library 的仓库，结构如下：

my-shared-library/
├── src/
├── vars/
├── resources/
└── README.md

3.2 配置 Jenkins 引用共享库

在 Jenkins 中引用共享库，你需要在全局配置中设置该库。步骤如下：

1. 打开 Jenkins 管理页面，进入 Manage Jenkins > Configure System。