创建可恢复的jenkins管道脚本

我最近正在考虑使用Jenkins管道脚本，一个问题是我没有想出一个聪明的方法来创建内部可重用的utils代码，想象一下，我有一个公共函数helloworld，它将被许多管道作业使用，所以我希望创建一个utils.jar，可以将它注入作业类路径。

我注意到Jenkins对全局库有类似的概念，但我对这个插件的担忧是：

由于它是一个插件，所以我们需要通过jenkins插件管理器安装/升级它，然后它可能需要重新启动才能应用更改，这不是我想看到的，因为utils可能会更改，总是添加，我们希望它能立即可用。

其次，这是jenkins的官方共享库，我不想（或者他们不会应用我们）把私有代码放进jenkins repo中。

有什么好主意吗？

共享库（docs）允许所有管道脚本访问您的代码。你不必为此构建一个插件，也不必重新启动Jenkins。

例如，这是我的库，这是调用这个公共函数的Jenkinsfile。

编辑（2017年2月）：该库可以通过Jenkins的内部Git服务器访问，也可以通过其他方式（例如通过Chef）部署到Jenkins用户主目录中的workflow-lib/目录（仍然有可能，但非常不愉快）。

全局库可以通过以下方式进行配置：

CCD_ 5中指向共享库repo的URL的CCD_
在Jenkins作业的文件夹级别上配置
在Jenkins配置中配置为全局库，其优点是代码受信任，即不受脚本安全性的约束

第一个和最后一个方法的混合将是一个未显式加载的共享库，然后仅使用其在Jenkinsfile:@Library('mysharedlib')中的名称来请求该共享库。

根据您计划重用代码的频率，您还可以加载一个函数（或一组函数）作为另一个管道的一部分。

{
  // ...your pipeline code...
  git 'http://urlToYourGit/projectContainingYourScript'
  pipeline = load 'global-functions.groovy'
  pipeline.helloworld()    // Call one of your defined function
  // ...some other pipeline code...
}

与StephenKing的解决方案相比，这个解决方案可能看起来有点麻烦，但我喜欢这个解决方案的地方在于，我的全局函数都提交给了Git，任何人都可以轻松地修改它们，而不需要（几乎）任何Jenkins的知识，只需要Groovy的基础知识。

在Groovy脚本中，您是loading，请确保在最后添加return this。这将允许您稍后拨打电话。否则，当您设置pipeline = load global-functions.groovy时，变量将设置为null。

以下是我们目前用于重用Jenkinsfile代码的解决方案：

node {
  curl_cmd = "curl -H 'Accept: application/vnd.github.v3.raw' -H 'Authorization: token ${env.GITHUB_TOKEN}' https://raw.githubusercontent.com/example/foobar/master/shared/Jenkinsfile > Jenkinsfile.t
  sh "${curl_cmd}"
  load 'Jenkinsfile.tmp'
}

我可能有点难看，但它确实有效，除此之外，它还允许我们在共享代码之前或之后插入一些特定于存储库的代码。

我更喜欢创建一个从存储库调用的buildRepo()方法。它的签名是def call(givenConfig = [:])，因此也可以使用参数调用，例如：

buildRepo([
  "npm": [
    "cypress": false
  ]
])

我将参数保持在绝对最小值，并尝试依赖约定而不是配置。

我提供了一个默认配置，也是我放置文档的地方：

  def defaultConfig = [
    /**
      * The Jenkins node, or label, that will be allocated for this build.
      */
    "jenkinsNode": "BUILD",
    /**
      * All config specific to NPM repo type.
      */
    "npm": [
      /**
        * Whether or not to run Cypress tests, if there are any.
        */
      "cypress": true
    ]
  ]
  def effectiveConfig merge(defaultConfig, givenConfig)
  println "Configuration is documented here: https://whereverYouHos/getConfig.groovy"
  println "Default config: " + defaultConfig
  println "Given config: " + givenConfig
  println "Effective config: " + effectiveConfig

使用有效的配置和存储库的内容，我创建了一个构建计划。

...
derivedBuildPlan.npm.cypress = effectiveConfig.npm.cypress && packageJSON.devDependencies.cypress
...

构建计划是一些构建方法的输入，例如：

  node(buildPlan.jenkinsNode) {
    stage("Install") {
      sh "npm install"
    }
    stage("Build") {
      sh "npm run build"
    }
    if (buildPlan.npm.tslint) {
      stage("TSlint") {
        sh "npm run tslint"
      }
    }
    if (buildPlan.npm.eslint) {
      stage("ESlint") {
        sh "npm run eslint"
      }
    }
    if (buildPlan.npm.cypress) {
      stage("Cypress") {
        sh "npm run e2e:cypress"
      }
    }
  }

我在Jenkins.io上写了一篇关于这件事的博客：https://www.jenkins.io/blog/2020/10/21/a-sustainable-pattern-with-shared-library/

相关内容

最新更新

热门标签：