CODEWITHSUNDEEP
mavenmaven-3pom.xmlmaven-release-plugin
clarafaction
clarafaction

Reputation: 101

Maven 3.0's "mvn release:perform" doesn't like a pom.xml that isn't in its git repo's root directory

I have a question about Maven, the maven-release-plugin, git integration, pom.xml's, and having pom.xml's in subdirectories of the repo's local copy rather than in the root.

Here's the setup:

Here's the actual error I get during this process:

[INFO] --- maven-release-plugin:2.0:perform (default-cli) @ standard_parent_project ---
[INFO] Checking out the project to perform the release ...
[INFO] Executing: /bin/sh -c cd "/Users/___/DEV c8ion 01/maven_based_code/0maven/standard_parent_project/target" && git clone [email protected]:clarafaction/0maven.git '/Users/___/DEV c8ion 01/maven_based_code/0maven/standard_parent_project/target/checkout'
...
/* note, the pom.xml the build should go out of at this point is at
   '/Users/___/DEV c8ion 01/maven_based_code/0maven/standard_parent_project/target/checkout/standard_parent_project/pom.xml'
*/
...
[INFO] [ERROR] The goal you specified requires a project to execute but
    there is no POM in this directory
    (/Users/___/DEV c8ion 01/maven_based_code/0maven/standard_parent_project/target/checkout).
    Please verify you invoked Maven from the correct directory. -> [Help 1]

Thanks.

Upvotes: 10

Views: 5644

Answers (4)

PatS
PatS

Reputation: 11454

This question was asked over 10 years ago so I wanted to provide a more up-to-date answer.

As of Oct 2022, the current/modern Maven works without any problems in a sub-directory. The current version of the maven plugin release is version: 3.0.0-M6

All that is needed is the normal elements defined in your POM that the maven release plugin needs:

NOTE: It's also possible to pass these arguments via a command line, but I prefer having them in a file (in pom.xml, parent for <distributionManagement>, or even settings.xml to better document the process and make it easier for other devs on the team to deploy.

NOTE: I used maven version 3.8.5 with Java 11, but AFAIK the version of Java does not matter. The latest version of maven is 3.8.6 (at this time). I believe it would work with Java 8. And at this time, maven 4 is in alpha.

How it works

Assumptions

In this example the following is used:

Each of the apps or libraries are in a separate directory with no parent POM being used (in this example). So you can't type mvn clean install from the top level directory. This is similar to the original OP question. As one commenter said, this is type of problem happens in a polyglot repo where multiple languages and technologies are used.

Explanation of POM configuration needed

In lib1, the pom has the following defined (only showing settings for maven release plugin). NOTE: This is the SAME information that will be in all of the POMs for this repository.

    <scm>
        <connection>scm:[email protected]:user123/proj456.git</connection>
        <developerConnection>scm:[email protected]:user123/proj456.git</developerConnection>
        <tag>HEAD</tag>
    </scm>
    <distributionManagement>
        <downloadUrl>https://mynexus.example.com/repository/maven-public</downloadUrl>
        <repository>
            <id>proj456-release</id>
            <name>proj456 release distro</name>
            <url>https://mynexus.example.com/repository/proj456-release</url>
        </repository>
        <snapshotRepository>
            <uniqueVersion>true</uniqueVersion>
            <id>proj456-snapshot</id>
            <name>proj456 snapshot</name>
            <url>https://mynexus.example.com/repository/proj456-snapshot</url>
        </snapshotRepository>
    </distributionManagement>

NOTE: Your settings.xml file needs to contain your login or auth-credentials so that might look like:

    <servers>
        <server>
            <id>proj456-releases</id>
            <username>user123</username>
            <password>not-shown</password>
        </server>
        <server>
            <id>proj456-snapshot</id>
            <username>user123</username>
            <password>not-shown</password>
        </server>
    </servers>

When you have a separate git repo for each maven artifact you are working on, the <scm> tag will be different for each of them.

Creating a release

The normal maven release commands are used, just from the sub-directory:

cd $HOME/work/proj456
ls -1
app1
app2
lib1
lib2

# Now CD to the directory you want to create a release for
cd lib1
mvn release:clean
mvn release:prepare release:perform

At the end of this process, the maven release plugin will do all the things it normally does. For example,

  1. The -SNAPSHOT version in the POM is replaced with a release version (that you specify).
  2. A git commit is created with the release version.
  3. A maven build and package is created with that release.
  4. The maven package is pushed (uploaded) to the NEXUS repo (or maven central).
  5. The pom.xml is bumped to the next version (with -SNAPSHOT added) and git commit is made so future development occurs on next SNAPSHOT version.

See maven docs for maven release plugin for a complete list of the steps.

Upvotes: 1

Exceptiondev
Exceptiondev

Reputation: 121

This should do the trick:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-release-plugin</artifactId>
    <version>2.3.2</version>
    <executions>
        <execution>
            <id>default</id>
            <goals>
                <goal>perform</goal>
            </goals>
            <configuration>
                <pomFileName>your_path/your_pom.xml</pomFileName>
            </configuration>
        </execution>
    </executions>
</plugin>

Upvotes: 11

khmarbaise
khmarbaise

Reputation: 97359

The first thing is to understand git which has it's convention that every project has it's own repository. The next thing is that Maven has it's conventions and putting the pom.xml into the root of it's project is the most obvious one. Furthermore you are trying to fight against Maven and i will predict that you will lose the combat and make your life not easy. If your projects A and B are related (same versio number or same release times) in some kind you should think about a multi-module build which results in a structure like this:

root (Git Repos)
  +-- pom.xml
       +--- projectA (pom.xml)
       +--- projectB (pom.xml)

and you can do a release of both projectA (better calling it a module) and module b in a single step from the root.

Upvotes: -2

Ryan Stewart
Ryan Stewart

Reputation: 128779

You can do it in the same way you normally tell Maven to run from a POM that's somewhere else: the -f option. mvn --help describes it thusly:

-f,--file <arg>    Force the use of an alternate POM
                   file.

To do that in a release, you just need to pass the appropriate option to the release plugin. You can use the perform goal's "arguments" property to do that. This property just tells the release plugin some additional arguments to append to the mvn command it runs when doing the release. You can set it from the command line by appending -D arguments="-f path/to/pom" or set it permanently in the pom in the release plugin's configuration, something like

<plugin>
    <artifactId>maven-release-plugin</artifactId>
    <version>2.3</version>
    <configuration>
        <arguments>-f path/to/pom</arguments>
    </configuration>
</plugin>

Upvotes: 7

Related Questions