How to retrieve current workspace using Jenkins Pipeline Groovy script?

Question

I am trying to get the current workspace of my Jenkins build using a Groovy pipeline script:

node('master') { // PULL IN ENVIRONMENT VARIABLES // Jenkins makes these variables available for each job it runs def buildNumber = env.BUILD_NUMBER def workspace = env.WORKSPACE def buildUrl = env.BUILD_URL // PRINT ENVIRONMENT TO JOB echo "workspace directory is ${workspace}" echo "build URL is ${env.BUILD_URL}" }

It returns:

[Pipeline] Allocate node : Start Running on master in /Users/Shared/Jenkins/Home/jobs/test/workspace [Pipeline] node { [Pipeline] echo workspace directory is null [Pipeline] echo build URL is http://localhost:8080/job/test/5/ [Pipeline] } //node [Pipeline] Allocate node : End [Pipeline] End of Pipeline Finished: SUCCESS

Possible duplicate of Get absolute path to workspace directory in Jenkins Pipeline plugin — Jan Fabry
– Jan Fabry, Commented Mar 31, 2017 at 9:48

azbarcea · Accepted Answer · 2021-09-07 16:38:32Z

53

For me just ${WORKSPACE} worked without even initializing the variable workspace.

edited Sep 7, 2021 at 16:38

azbarcea

3,7172 gold badges22 silver badges27 bronze badges

answered Jul 28, 2017 at 6:21

Litty Philip

1,16511 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Rhubarb Over a year ago

me too but only with uppercase ${WORKSPACE} works, ${workspace} does NOT

Arghya Over a year ago

${WORKSPACE} works for me too and not ${workspace}. ${workspace} is taken as class workspace

Krzysztof Krasoń · Accepted Answer · 2016-07-31 04:40:01Z

There is no variable included for that yet, so you have to use shell-out-read-file method:

sh 'pwd > workspace' workspace = readFile('workspace').trim()

Or (if running on master node):

workspace = pwd()

Don't forget to trim() your readFile() result, otherwise you will end up with a newline out of nowhere.

chris_f · Accepted Answer · 2016-08-05 13:17:13Z

I think you can also execute the pwd() function on the particular node:

node { def PWD = pwd(); ... }

Ismail · Accepted Answer · 2019-07-18 07:29:52Z

A quick note for anyone who is using bat in the job and needs to access Workspace:

It won't work.

$WORKSPACE https://issues.jenkins-ci.org/browse/JENKINS-33511 as mentioned here only works with PowerShell. So your code should have powershell for execution

 stage('Verifying Workspace') { powershell label: '', script: 'dir $WORKSPACE' }

this sounds as its only working that way on Windows systems.

Saikat · Accepted Answer · 2020-06-23 07:59:24Z

I have successfully used as shown below in Jenkinsfile:

steps { script { def reportPath = "${WORKSPACE}/target/report" ... } }

Patrick Beagan · Accepted Answer · 2022-04-15 00:20:24Z

2

The key is that, this works if used within double quotes instead of single quotes, below is my code and this worked!

script { echo 'Entering Stage - Nexus Upload' def artefactPath = "${WORKSPACE}/build/deploy/identityiq.war" echo "printing the path ${artefactPath}" }

edited Apr 15, 2022 at 0:20

Patrick Beagan

9461 gold badge7 silver badges11 bronze badges

answered Apr 14, 2022 at 8:16

user18801436

211 bronze badge

1 Comment

ptha Over a year ago

Groovy does not interpolate strings in single quotes '${WORKSPACE}', only in double quotes: "${WORKSPACE}". Similarly it will interpolate strings in triple double quotes """${WORKSPACE}""", but not in triple single quotes '''${WORKSPACE}'''. See groovy-lang.org/syntax.html#_string_interpolation for more details.

doelleri · Accepted Answer · 2018-07-24 22:20:59Z

This is where you can find the answer in the job-dsl-plugin code.

Basically you can do something like this:

readFileFromWorkspace('src/main/groovy/com/groovy/jenkins/scripts/enable_safehtml.groovy')

Upen · Accepted Answer · 2019-12-06 20:54:25Z

In Jenkins pipeline script, I am using

targetDir = workspace

Works perfect for me. No need to use ${WORKSPACE}

Collectives™ on Stack Overflow

How to retrieve current workspace using Jenkins Pipeline Groovy script?

8 Answers 8

2 Comments

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

2 Comments

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Comments

Linked

Related