我可以“导入”詹金斯声明管道中的阶段吗答案

【问题标题】：Can I "import" the stages in a Jenkins Declarative pipeline我可以“导入”詹金斯声明管道中的阶段吗
【发布时间】：2017-05-31 08:37:06
【问题描述】：

我有几个管道作业，它们的配置非常相似。它们都有相同的阶段（大约有 10 个阶段）。

我现在正在考虑转向声明式管道 (https://jenkins.io/blog/2016/09/19/blueocean-beta-declarative-pipeline-pipeline-editor/)。

但我不想在每个管道中定义约 10 个阶段。我想在一个地方定义它们，然后以某种方式“导入”它们。

这完全可以通过声明性管道实现吗？我看到有库，但我似乎无法使用它们包含舞台定义。

【问题讨论】：

你修好了吗？我正在尝试做同样的事情，我尝试使用共享库，但似乎您不能在阶段块调用 groocy 文件（在共享库中的 vars 中），它只能作为一个步骤。跨度>
This github repo 似乎有一些类似于所需的东西，但它似乎不适用于管道。

标签： jenkins jenkins-pipeline

【解决方案1】：

您必须创建一个共享库来实现我将要提出的建议。对于共享库的实现，您可以查看以下帖子：

Using Building Blocks in Jenkins Declarative Pipeline

Upload file in Jenkins input step to workspace（主要是图片，方便看东西）

现在，如果您想使用可以跨多个项目（作业）重用的 Jenkinsfile（一种模板），那么这确实是可能的。

一旦您创建了一个包含vars 目录的共享库存储库，那么您只需在vars 目录中创建一个Groovy 文件（比如说commonPipeline.groovy）。

这是一个有效的示例，因为我之前在多个作业中使用过它。

$ cat shared-lib/vars/commonPipeline.groovy

// You can create function(s) as shown below, if required
def someFunctionA() {
    // Your code
}

// This is where you will define all the stages that you want
// to run as a whole in multiple projects (jobs)
def call(Map config) {
    pipeline {
        agent {
            node { label 'slaveA || slaveB' }
        }

        environment {
            myvar_Y = 'apple'
            myvar_Z = 'orange'
        }

        stages {
            stage('Checkout') {
                steps {
                    deleteDir()
                    checkout scm
                }
            }

            stage ('Build') {
                steps {
                    script {
                        check_something = someFunctionA()

                        if (check_something) {
                            echo "Build!"
                            # your_build_code
                        } else {
                            error "Something bad happened! Exiting..."
                        }
                    }
                }
            }

            stage ('Test') {
                steps {
                    echo "Running tests..."
                    // your_test_code
                }
            }

            stage ('Deploy') {
                steps {
                    script {
                        sh '''
                            # your_deploy_code
                        '''
                    }
                }
            }
        }
        post {
            failure {
                sh '''
                    # anything_you_need_to_perform_in_failure_step
                ''' 
            }

            success {
                sh '''
                    # anything_you_need_to_perform_in_success_step
                '''
            }
        }
    }
}

有了上面的 Groovy 文件，您现在要做的就是在您的各种 Jenkins 项目中调用它。由于您的 Jenkins 项目中可能已经有一个现有的 Jenkinsfile（如果没有，请创建它），您只需将该文件的现有内容替换为以下内容：

$ cat Jenkinsfile
// Assuming you have named your shared-library as `my-shared-lib` & `Default version` to `master` branch in 
// `Manage Jenkins` » `Configure System` » `Global Pipeline Libraries` section
@Library('my-shared-lib@master')_

def params = [:]

params=[
    jenkins_var: "${env.JOB_BASE_NAME}",
]

commonPipeline params

注意：正如您在上面看到的，我正在调用commonPipeline.groovy 文件。因此，您所有庞大的 Jenkinsfile 将减少到只有五六行代码，而这几行代码也将在所有这些项目中通用。另请注意，我在上面使用了jenkins_var。它可以是任何名称。它实际上并未使用，但 是运行管道所必需的。一些 Groovy 专家可以澄清这部分。

参考：https://www.jenkins.io/blog/2017/10/02/pipeline-templates-with-shared-libraries/

【讨论】：