在Jenkins声明管道中使用构建块

Question

我刚开始使用Jenkins声明性管道。在我支持一些类似的项目时，我考虑将类似的管道步骤（甚至阶段）放入可重用的构建块中。这些区块应保持在一个中心点，然后由单独的管道包括在内（例如：干燥）。

我将共享库视为脚本化管道的一个选项，但我不确定它是否也适用于声明性管道。

你知道在Jenkins声明性管道中使用像构建块这样的东西的方法吗？

举例说明：

如果您有一个用于Maven项目的标准管道（例如Spring Boot），它看起来有点像：

pipeline {
    agent {
        dockerfile true
    }
    stages {
        stage('Build') {
            steps {
                sh 'mvn -U -DskipTests clean package'
            }
        }
        stage('Test') {
            parallel {
                stage('Unit Tests') {
                    steps {
                        sh 'mvn test'
                    }
                }
                stage('Integration Tests') {
                    steps {
                        sh 'mvn integration-test'
                    }
                }
            }
        }
        stage('Deploy') {
            steps {
                sh 'mvn deploy'
            }
        }
    }
}

但是，与其将此复制到所有项目中，如果下面的用例可以轻松处理，那就太好了。

对于不需要自定义的项目，最好将其用于examle，如：

defaultMavenpipeline{}

其中defaultMaven管道将被上述管道替换（我认为这对于共享库是可能的）。

对于一个只需要定制一些阶段的项目，这样的事情可能吗？

pipeline {
    defaultDockerAgent{}
    stages {
        stage('Build') {
            steps {
                sh 'mvn -U -DskipTests clean package'
                // ... customize some stuff ...
            }
        }
        defaultTestStage{}
        stage('Deploy') {
            steps {
                // ... customize some stuff ...
                sh 'mvn deploy'
            }
        }
    }
}

很抱歉长时间的帖子，非常感谢你提前！

Answer 1

您可以为此使用共享库。

我使用库中的vars部分来定义一个模板（工作流），src部分用可重用的方法编写类，从jenkins文件中，我只调用模板，为它提供项目特定的参数映射。

这允许我让开发人员只通过克隆和修改Jenkins文件来创建自己的项目，而我仍然可以控制执行。

在Jenkins文件中：

@Library('jenkinssharedlibrary') _
templatename([
parameter1: "value",
parameter2: "value"])

在共享库中：vars/templatename.groovy

import com.mydomain.someclassivemade
def call(Map<String, String> passedConfig) {
Myclass niceobject = new Myclass()
 pipeline {
        agent {
            label 'test'
        }
        environment {
            PROJECT_VERSION = "${passedConfig.version}"
        }
        tools {
            jdk '....'
        }
        stages {                
         steps {
                script {
                    niceobject.compile(mvn)
                }
            }}
}

在src文件夹中，您用重用的方法编写类： /src/com/mydomain/Someclassivemade.groovy

 package com.mydomain.someclassivemade
 def build (final String xyz){
   sh("build comand with parameters")
 } 
 return this // very important line :) 

在一种更简单的方法中，您可以将方法放在vars中，并从jenkins文件中调用它们。詹金斯的力量在于它的灵活性。

另一个有用的链接

PS：我可能有语法错误，因为我直接写在这里，请告诉我修复它们！

Answer 2

您可以将声明性管道与共享库一起使用。

请按照以下步骤操作：

1） 创建共享库

• 创建存储库共享库
• 在上述存储库中创建名为vars的目录。在vars目录中，创建一个文件sayHello。groovy具有以下内容：

// vars/sayHello.groovy
def call(String name = 'human') {
    // Any valid steps can be called from this code.
    // Can be used in both scripted and declarative pipeline
    echo "Hello, ${name}."
}

2）配置Jenkins在任何管道作业中访问共享库

• 转到管理Jenkins»配置系统»全局管道库部分
• 根据需要命名库（在我的示例中，我的共享库如下所示）
• 添加包含Groovy代码的分支名称。在我的例子中，它位于默认分支中，即master
• 除非您知道自己在做什么，否则无需选中/取消选中复选框

3） 访问项目中的共享库

• 在Jenkinsfile或Pipeline脚本部分，添加以下代码：

@Library('my-shared-lib')_

pipeline {
    agent any

    stages {
        stage('Info') {
            steps {
                echo 'Publishing some details here'
            }
        }

        stage('Using shared-library') {
            steps {
                sayHello 'Alex'
            }
        }
    }
}

就这样。你完了！：）

注意：对于Jenkinsfile中共享库中使用的下划线（）（来自官方链接），对于仅定义全局变量的共享库（vars/），或仅需要全局变量的Jenkinsfile，注释模式@Library（'my-shared-Library'）对于保持代码简洁可能很有用。本质上，符号\uu不是注释不必要的导入语句，而是注释符号。

输出：