Jenkins 进阶：Jenkins共享库(ShareLibrary)

Jenkins Shared Libraries 是一种高级特性，允许用户将常用的 Pipeline 脚本代码抽取到单独的 Git 仓库中进行管理和重用。这不仅提高了代码的可维护性，还促进了团队间最佳实践的分享。下面详细介绍如何创建和使用 Jenkins Shared Libraries。

创建共享库

1. 创建 Git 仓库: 首先，在Git服务器上创建一个新的仓库，用于存放你的共享库代码。例如，命名为 jenkins-shared-libraries。

2. 目录结构: 在仓库中，创建一个名为 src 的目录，并在其中创建 resources 和 vars 目录。resources 用于存放非Groovy的资源文件（如配置文件），而 vars 目录用于存放可直接调用的Groovy脚本（函数）。

   jenkins-shared-libraries/
   ├── src/
   │   ├── resources/
   │   └── vars/
   │       ├── myCustomStep.groovy
   │       └── anotherFunction.groovy
   └── (其他如README.md等)
   

3. 编写共享函数: 在 vars 目录下，每个 .groovy 文件代表一个可直接从 Pipeline 调用的函数。文件名即为函数名。例如，在 myCustomStep.groovy 中定义一个函数：

   def call(String message = 'Hello World') {
       echo message
   }
   

4. 版本控制与推送: 提交你的更改并推送到Git仓库。

在 Jenkins 中配置共享库

1. 进入系统管理: 登录 Jenkins，点击 “Manage Jenkins” -> “Managed Plugins”，确保 “Pipeline: Shared Groovy Libraries” 插件已安装。

2. 配置共享库: 转到 “Manage Jenkins” -> “Configure System” -> “Global Pipeline Libraries” 部分，点击 “Add” 添加新的共享库。

3. 填写配置信息:

   • Name: 给共享库起个名字，如 my-shared-lib。
   • Retrieval Method: 选择 “Modern SCM”，然后选择你的Git服务类型（如Git）。
   • Repository URL: 填写你的Git仓库URL。
   • Credentials: 如果仓库需要认证，选择或添加相应的凭证。
   • Version: 可以指定分支或标签，如 */master 或特定版本号，留空则默认使用HEAD。
   • Load implicitly: 是否自动加载此库到所有Pipeline，或仅在明确引用时加载。

4. 保存配置。

在 Pipeline 中使用共享库

在你的 Jenkinsfile 中，使用 @Library 注解来导入共享库，并调用其函数。

@Library('my-shared-lib@version') _ // 注意: version 可选，表示特定版本或分支

pipeline {
    stages {
        stage('Example') {
            steps {
                myCustomStep('This is a custom step message.')
            }
        }
    }
}

注意事项

• 确保共享库的Git仓库对Jenkins服务器可访问。
• 函数名应遵循Groovy的命名规则，且文件名需与函数名完全匹配（不包括.groovy后缀）。
• 共享库可以有复杂的结构，支持类和包的定义，详情可参考官方文档。

通过合理设计和使用共享库，可以极大地提升Jenkins Pipeline的开发效率和维护性。