Use Jenkins WORKSPACE environment variable in Jenkins declarative pipeline parameter

Question

Is there a way to use Jenkins WORKSPACE environment variable in Jenkins declarative pipeline parameters?

Below attempt failed.

pipeline {
    parameters {
        extendedChoice description: 'Template in project',
                        multiSelectDelimiter: ',', name: 'TEMPLATE',
                        propertyFile:  env.WORKSPACE + '/templates.properties', 
                        quoteValue: false, saveJSONParameterToFile: false, type: 'PT_MULTI_LEVEL_SINGLE_SELECT',
                        value: 'Project,Template', visibleItemCount: 6
   ...
   } 
   stages { 
   ...
   }

propertyFile: '${WORKSPACE}/templates.properties' didn't work either.

Try using "templates.properties", the plugin may assume the path is relative to workspace. — MaratC, Feb 24 '21 at 15:03

Samit Kumar Patel · Accepted Answer · 2021-02-24T18:21:11.747

7

The environment variable can be accessed in various place in Jenkinsfile like:

def workspace
node {
    workspace = env.WORKSPACE
}
pipeline {
    agent any;
    parameters {
        string(name: 'JENKINS_WORKSPACE', defaultValue: workspace, description: 'Jenkins WORKSPACE')
    }
    stages {
        stage('access env variable') {
            steps {
                // in groovy
                echo "${env.WORKSPACE}"
                
                //in shell
                sh 'echo $WORKSPACE'
                
                // in groovy script 
                script {
                    print env.WORKSPACE
                }
            }
        }
    }
}

edited Feb 24 '21 at 18:21

answered Feb 21 '21 at 19:54

Samit Kumar Patel

1,932
1
13
20

there's issue with accessing environment variables in parameters – rok Feb 22 '21 at 09:05
1

In parameters also you have to use the interpolation in double quote “${env.WORKSPACE}” – Samit Kumar Patel Feb 24 '21 at 16:08
I have edited my answer which explains how you can get env variable in the parameter – Samit Kumar Patel Feb 24 '21 at 18:22
1

Thanks. `echo "${env.WORKSPACE}"` worked as expected – rok Jul 25 '21 at 13:37

score 0 · Answer 2 · answered Feb 22 '21 at 14:22

The only way that worked is putting absolute path to Jenkins master workspace where properties file is located.

pipeline {
    parameters {
        extendedChoice description: 'Template in project',
                        multiSelectDelimiter: ',', name: 'TEMPLATE',
                        propertyFile:  'absolute_path_to_master_workspace/templates.properties', 
                        quoteValue: false, saveJSONParameterToFile: false, type: 'PT_MULTI_LEVEL_SINGLE_SELECT',
                        value: 'Project,Template', visibleItemCount: 6
   ...
   } 
   stages { 
   ...
   }

It seems that environment variables are not available during pipeline parameters definition before the pipeline actually triggered.

Use Jenkins WORKSPACE environment variable in Jenkins declarative pipeline parameter

2 Answers2