Question

我的要求很简单，我只想外化一些'值'以使我的Jenkins文件更易于使用，为此我需要从一个文件加载属性，该文件将在Jenkinsfile旁边，并确保这些属性可在管道中的任何位置使用。我仍然是groovy和Jenkins代码的新手，但从未想过这么简单的事情会如此困难。我在脚本安全插件中启用了一些方法，但是下面的代码（以及我尝试过的几种变体）总是会出错或打印null或者给我NPE。我尝试了多种组合，下面的代码只是其中之一。

properties = null

@NonCPS
def loadProperties() {
    checkout scm
    File propertiesFile = new File('${workspace}/pipeline.properties')
    propertiesFile.withInputStream {
            properties.load(propertiesFile)
    }
}

pipeline {
    agent none

    stages {

        stage ('prepare') {
            agent any

            steps {
                script {
                loadProperties()
                echo "${properties['repo']}"
                }
            }
        }
        stage('Build') {

            agent any

            steps {
                sh 'echo ${properties.repo}'
            }

        }
    }
}

Answer 1

我想出了几种在Jenkins管道中外部化属性的方法。您可以根据主要区别选择您的选择。

1）完全使用groovy代码。此代码段要求您在“进程内脚本批准”中启用多个方法签名。它带有脚本安全插件，因此只有在适当考虑后才能完成。

properties = null     

def loadProperties() {
    node {
        checkout scm
        properties = new Properties()
        File propertiesFile = new File("${workspace}/pipeline.properties")
        properties.load(propertiesFile.newDataInputStream())
        echo "Immediate one ${properties.repo}"
    }
}

pipeline {
    agent none

    stages {
        stage ('prepare') {
            agent any

            steps {
                script {
                    loadProperties()
                    echo "Later one ${properties.branch}"
                }
            }
        }
        stage('Build') {
            agent { label 'master'  }

            steps {
                // works fine. properties is available everywhere
                echo properties.branch
            }           
        }
    }
}

2）使用管道实用程序步骤插件 - 管道插件套件默认包含此功能，它允许更好的方式加载属性，而无需启用安全性异常。我会推荐这种方法。

properties = null

def loadProperties() {
    node {
        checkout scm
        properties = readProperties file: 'pipeline.properties'
        echo "Immediate one ${properties.repo}"
    }
}

pipeline {
    agent none

    stages {           
        stage ('prepare') {
            agent any

            steps {
                script {
                    loadProperties()
                    echo "Later one ${properties.ansible}"
                }
            }
        }
        stage('Build') {

            agent any

            steps {
                echo properties.branch
            }

        }
    }
}

Answer 2

使用“管道实用程序步骤”插件，您可以定义可用于所有阶段的常规变量。例如，将props.txt设置为：

version=1.0
fix=alfa

并将脚本和声明性Jenkins管道混合为：

def props
def VERSION
def FIX
def RELEASE

node {
   props = readProperties file:'props.txt'
   VERSION = props['version']
   FIX = props['fix']
   RELEASE = VERSION + "_" + FIX
}

pipeline {
   stages {
      stage('Build') {
         echo ${RELEASE}
      }
   }
}

Answer 3

感谢答案1。这很有帮助，我使用了选项2。我遇到了一些问题，并且想分享我的解决方案：

1）我在声明式管道的管道部分内添加了一个“准备”阶段：

stage ('Prepare') {
   steps {
      script {
         properties = readProperties file: 'scripts/jenkins-pipelines/branch-specific.properties'
         echo "Running build ${JOB_NAME} # ${BUILD_NUMBER} on git repo ${properties.GitURL} branch ${properties.nextBranchName}"
       }
     }
   }
}

属性文件的格式为：

nextBranchName=next
stableBranchName=master
GitURL=git@github.com:foo.git

请注意，属性上没有报价。

在其他步骤，阶段和发布中，我也将该属性用作$ {properties.nextBranchName}。如答案1所述：有必要安装“管道实用程序步骤”插件

从属性文件加载属性并使其在整个作业/管道中可用 - Jenkins声明性语法

3 个答案: