Max Nanasy
Max Nanasy

Reputation: 6141

Is there any way to change the working directory of a Jenkins Maven build?

Is there any way to change the working directory of a Jenkins Maven build?

Use Case

There is a Maven build that will only work if the current working directory is the directory with pom.xml in it, so I want the Maven build to execute in that directory.

The directory with the pom.xml is in a subdirectory of a git project.

Upvotes: 33

Views: 71766

Answers (9)

I came here because I had the same situation described, The version of Hudson / Jenkins that I have has the same problem, it does not allow setting the working directory before calling maven.

The workaround is to configure a parameter that has the desired working directory, create a new command "mvn" that makes the change directory and then invoke the original command "mvn" of maven with all the arguments.

steps to follow:

  1. In the project it should be noted that the project needs to be parameterized, in my case create the parameter WORKING_DIRECTORY with value $ {WORKSPACE}/maven, being "maven" the subfolder that will be the working directory. enter image description here

  2. Create a "custom" version of maven to modify the "mvn" command:

cp -ip /opt/apache-maven-3.5.4 /opt/maven_custom

mv /opt/maven_custom/mvn /opt/maven_custom/mvn_original

vi /opt/maven_custom/mvn:

-- content new mvn command --

cd $WORKING_DIRECTORY

/opt/maven_custom/bin/mvn_original "$@"

-- end content new mvn command --

chmod ugo+x /opt/maven_custom/mvn

  1. Add the new maven_custom in hudson/Jenking:

    Hudson Admin --> System Configurations --> Maven --> Add maven

  2. Use the custom maven in the project

With these changes maven runs in a different working directory

Upvotes: 2

Gert-Jan Paulissen
Gert-Jan Paulissen

Reputation: 11

When the subdirectory is a direct child of the parent root, you could use mvn --projects since that changes into the subdirectory. Here a proof (see last line):

U:\git\ics-VCCUSTOM-422>mvn --projects icsIntegrationTest clean verify
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------< com.afklm.vccustom:icsIntegrationTest >----------------
[INFO] Building icsIntegrationTest 13.3.4-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ icsIntegrationTest ---
[INFO] Deleting U:\git\ics-VCCUSTOM-422\icsIntegrationTest\target
[INFO]
[INFO] --- buildnumber-maven-plugin:1.3:create (default) @ icsIntegrationTest ---
[INFO] ShortRevision tag detected. The value is '7'.
[INFO] Executing: cmd.exe /X /C "git rev-parse --verify --short=7 HEAD"
[INFO] Working directory: U:\git\ics-VCCUSTOM-422\icsIntegrationTest

Upvotes: 1

ton
ton

Reputation: 4607

Create a target to checkout the parent.

  • Checkout the parent dir of your build target
  • Set Build -> Goal = clean
  • Run build and ascertain the destination workspace directory (second line of console output, in my sample /var/lib/jenkins/workspace/my_project)

Create a target to build your path

  • DO NOT check "Delete workspace before build starts"
  • In Build -> Advanced - Check "Change folder of workspace" and paste your /yourtargetdirectory

It worked for me.

Upvotes: 13

Foon
Foon

Reputation: 6478

Not sure when this was added, but for the Jenkins in front of me (Jenkins ver. 1.627 per the bottom of the page), there's now an option for defining where the root pom.xml is (help message says:

If your workspace has the top-level pom.xml in somewhere other than the 1st module's root directory, specify the path (relative to the module root) here, such as parent/pom.xml. If left empty, defaults to pom.xml

). I was facing the same issue but then realized the answer was staring me in the face (note that I did not have to hit advanced as Hua2308 suggested, probably because they changed the UI)

Upvotes: 11

tkruse
tkruse

Reputation: 10695

Solution:

cd subfolder; mvn -f ../pom.xml task

Maven does not provide an option to do it the other way round, meaning the sensible way for this use-case, probably because Maven hates you.

Upvotes: 0

Hua2308
Hua2308

Reputation: 469

For a reference, here is what works for me. In the "Invoke top-level Maven targets" build step, there is an "Advanced..." button. If you click this button, you can specify the relative path to your POM.xml file. This should ensure you are only building the desired project in the subdirectory.

Upvotes: 5

madhead
madhead

Reputation: 33501

You can use Maven's -f option

-f,--file <arg>    Force the use of an alternate POM file (or directory with pom.xml).

For example if your project has a structure:

README.md
sources
|----pom.xml
|----services
|    |----pom.xml
|    +----src
|----webservices
|    |----pom.xml
|    +----src
+----....
useful
docs

then you can use Goals in Invoke top-level Maven targets:

-f sources/pom.xml clean install

Upvotes: 2

tbrugz
tbrugz

Reputation: 500

Go to the configuration of your maven project, then:

Build > click the "Advanced" button > check "Use custom workspace" > set the directory

(I'm using Jenkins version 1.508)

Upvotes: 1

Andr&#233; Stannek
Andr&#233; Stannek

Reputation: 7863

The Jenkins we are working with is in German so I'm trying to guess how the options are translated.

Go to the configuration of your project and there go to enhanced project configuration (it's the second section) and expand it. The last point should be something like Change folder of workspace. I think that might be what you are looking for.

Otherwise you can always go to the Build options and change the path to your pom.xml

Upvotes: 0

Related Questions