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

https://issues.jenkins-ci.org/plugins/servlet/mobile#issue/JENKINS-33511 — tim_yates, Jun 15 '16 at 21:26
Possible duplicate of [Get absolute path to workspace directory in Jenkins Pipeline plugin](http://stackoverflow.com/questions/36934028/get-absolute-path-to-workspace-directory-in-jenkins-pipeline-plugin) — Jan Fabry, Mar 31 '17 at 09:48

score 45 · Answer 1 · edited Sep 07 '21 at 16:38

45

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

edited Sep 07 '21 at 16:38

azbarcea

3,323
1
20
25

answered Jul 28 '17 at 06:21

Litty Philip

1,027
10
12

32

me too but only with uppercase `${WORKSPACE}` works, `${workspace}` does NOT – Rhubarb Aug 16 '17 at 12:43
1

`${WORKSPACE}` works for me too and not `${workspace}`. `${workspace}` is taken as `class workspace` – Arghya Jan 02 '20 at 11:23

Krzysztof Krasoń · Answer 2 · 2016-07-31T04:40:01.163

7

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()

edited Jul 31 '16 at 04:40

answered Jun 16 '16 at 06:30

Krzysztof Krasoń

26,515
16
89
115

Don't forget to trim() your readFile() result, otherwise you will end up with a newline out of nowhere. – Chadi Jul 05 '16 at 13:44

score 5 · Answer 3 · answered Aug 05 '16 at 13:17

5

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

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

answered Aug 05 '16 at 13:17

chris_f

1,081
8
17

score 5 · Answer 4 · answered Jul 18 '19 at 07:29

5

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'
}

answered Jul 18 '19 at 07:29

Ismail

779
1
8
18

this sounds as its only working that way on Windows systems. – Alexander Stohr Apr 14 '23 at 08:55

score 4 · Answer 5 · answered Jun 23 '20 at 07:59

4

I have successfully used as shown below in Jenkinsfile:

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

answered Jun 23 '20 at 07:59

Saikat

14,222
20
104
125

score 2 · Answer 6 · edited Apr 15 '22 at 00:20

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 '22 at 00:20

Patrick Beagan

906
1
7
11

answered Apr 14 '22 at 08:16

user18801436

21
1

score 0 · Answer 7 · edited Jul 24 '18 at 22:20

0

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')

edited Jul 24 '18 at 22:20

doelleri

19,232
5
61
65

answered Jul 24 '18 at 15:12

Dresden

31
1
7

score 0 · Answer 8 · answered Dec 06 '19 at 20:54

0

In Jenkins pipeline script, I am using

targetDir = workspace

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

answered Dec 06 '19 at 20:54

Upen

1,388
1
22
49

How to retrieve current workspace using Jenkins Pipeline Groovy script?

8 Answers8

Linked