前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Jenkins2 学习系列12 -- 创建和使用共享库

Jenkins2 学习系列12 -- 创建和使用共享库

作者头像
mafeifan
发布2019-07-22 16:44:14
2.9K0
发布2019-07-22 16:44:14
举报
文章被收录于专栏:finleyMa

当有大量的pipeline项目构建任务,有很多代码是重复的,这时需要提取和复用共同的逻辑。 其实pipeline本质就是一个Groovy脚本,所以可以在pipeline中自定义函数,并使用Groovy语言自带的特性。 比如下面的Jenkinsfile,我们自定义了一个 createVersion 函数,并使用了内置的Date类。

代码语言:javascript
复制
pipeline {
    agent any
    
    stages {
        stage ('build') {
            steps {
                // 输出 201907-4
                echo "${createVersion(BUILD_NUMBER)}"
            }
        }
    }
}

def createVersion(String BUILD_NUMBER) {
    return new Date().format('yyyyMM') + "-${BUILD_NUMBER}"
}

还有一种更优雅的写法,将变量定义在environment内

代码语言:javascript
复制
pipeline {
    agent any
    
    environment {
       _version = createVersion()
    }
    
    stages {
        stage ('build') {
            steps {
                echo "${_version}"
            }
        }
    }
}

def createVersion() {
    return new Date().format('yyyyMM') + "-${env.BUILD_NUMBER}"
}
使用共享库

大致流程:

  1. 新建个Groovy仓库,里面包含共享库代码

这里已经建好 jenkins-shared-library,文件结构如下:

image.png

vars 目录下的全局变量可以直接在pipeline中使用,即当写sayHello('world'),实际调用的是sayHello.groovy中的call函数

src 目录是标准的Java源码结构,目录中的类被称为类库(Library class),而 @Library('global-shared-library@master') 就是一次性静态加载src目录下所有代码到classpath中。

src目录中的类,可以使用Groovy中的@Grab注解,自动下载第三方依赖包

  1. Jenkins 管理后台配置仓库地址和版本等 进入 Jenkins 的Manage Jenkins -> Configure System -> Global Pipeline Libraries 配置页面

image.png

  1. Jenkins 项目的pipeline中引入共享库(可以指定仓库版本和具体class) 新建一pipeline类型的job。 Pipeline内容如下:
代码语言:javascript
复制
@Library('global-shared-library@master') _
pipeline {
    agent any
    
    environment {
       _version = createVersion()
    }
    
    stages {
        stage ('build') {
            steps {
                script {
                    def util = new com.mafeifan.Utils()
                    def version = util.createVersion("${BUILD_NUMBER}")
                    echo "${version}"
                    sayHello 'yes'
                    echo "${_version}"
                }
            }
        }
    }
}

def createVersion() {
    return new Date().format('yyyyMM') + "-${env.BUILD_NUMBER}"
}

查看构建日志,发现Jenkins首先拉取共享库代码,执行成功。

image.png

使用共享库实现Pipeline模板

// vars/generatePipeline.groovy

代码语言:javascript
复制
def call(String lang) {
  if (lang == 'go') {
    pipeline {
      agent any
       stages {
         stage ('set go path') {
            steps {
               echo "GO path is ready"
            }
         }
       }
    } 
  } else if (lang == 'java') {
    pipeline {
      agent any
       stages {
         stage ('clean install') {
            steps {
               sh "mvn clean install"
            }
         }
       }
    } 
  }
  // 其他语言
}

使用时,Jenkinsfile 只有两行

代码语言:javascript
复制
@Library['global-shared-library'] _
generatePipeline('go')

如果大多数项目都是标准化的,可以利用共享库的pipeline模块技术来降低维护成本。

这里只是抛砖引玉,想写出更强大的共享库需要多了解Groovy。

优先考虑使用自定义函数,如果此函数出现在了至少三个项目中,考虑移到共享库里,当发现项目的pipeline非常相似,考虑使用pipeline模块。

参考

https://jenkins.io/zh/doc/book/pipeline/shared-libraries/

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019.07.21 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 使用共享库
  • 使用共享库实现Pipeline模板
  • 参考
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档