Skip to content

Upgrade to Maven 4.0.0-rc-4 and editions #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
desruisseaux merged 3 commits into from
Oct 17, 2025
Merged

Upgrade to Maven 4.0.0-rc-4 and editions #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04712fd
Upgrade to Maven 4.0.0-rc-4.
desruisseaux Oct 5, 2025
33ef009
Remove the `useDefaultManifestFile` configuration parameter, which wa…
desruisseaux Oct 12, 2025
a2932ac
Edition in Javadoc (mostly formatting) and minor code simplifications.
desruisseaux Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/maven-verify.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
name: Verify
uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v4
with:
ff-maven: "4.0.0-rc-2" # Maven version for fail-fast-build
maven-matrix: '[ "4.0.0-rc-2" ]'
ff-maven: "4.0.0-rc-4" # Maven version for fail-fast-build
maven-matrix: '[ "4.0.0-rc-4" ]'
jdk-matrix: '[ "17", "21" ]'
10 changes: 8 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@

<properties>
<javaVersion>17</javaVersion>
<mavenVersion>4.0.0-rc-2</mavenVersion>
<mavenVersion>4.0.0-rc-4</mavenVersion>

<guiceVersion>6.0.0</guiceVersion>
<junitVersion>5.13.4</junitVersion>
<mavenArchiverVersion>4.0.0-beta-5</mavenArchiverVersion>
<mavenFileManagementVersion>3.2.0</mavenFileManagementVersion>
<mavenPluginPluginVersion>4.0.0-beta-1</mavenPluginPluginVersion>
<mavenPluginTestingVersion>4.0.0-beta-3</mavenPluginTestingVersion>
<mavenPluginTestingVersion>4.0.0-beta-4</mavenPluginTestingVersion>
<plexusArchiverVersion>4.10.2</plexusArchiverVersion>

<version.maven-plugin-tools>${mavenPluginPluginVersion}</version.maven-plugin-tools>
Expand Down Expand Up @@ -138,6 +138,12 @@
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-xml</artifactId>
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.shared</groupId>
<artifactId>file-management</artifactId>
Expand Down
19 changes: 0 additions & 19 deletions src/it/MJAR-210/invoker.properties
View file
Open in desktop

This file was deleted.

39 changes: 0 additions & 39 deletions src/it/MJAR-210/pom.xml
View file
Open in desktop

This file was deleted.

132 changes: 60 additions & 72 deletions src/main/java/org/apache/maven/plugins/jar/AbstractJarMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@
*/
package org.apache.maven.plugins.jar;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;
import java.util.jar.Attributes;
import java.util.stream.Stream;

import org.apache.maven.api.ProducedArtifact;
Expand All @@ -43,10 +45,9 @@
import org.codehaus.plexus.archiver.jar.JarArchiver;

/**
* Base class for creating a jar from project classes.
* Base class for creating a <abbr>JAR</abbr> file from project classes.
*
* @author <a href="[email protected]">Emmanuel Venisse</a>
* @version $Id$
*/
public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Mojo {

Expand All @@ -56,8 +57,6 @@ public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Moj

private static final String MODULE_DESCRIPTOR_FILE_NAME = "module-info.class";

private static final String SEPARATOR = FileSystems.getDefault().getSeparator();

/**
* List of files to include. Specified as fileset patterns which are relative to the input directory whose contents
* is being packaged into the JAR.
Expand Down Expand Up @@ -85,19 +84,19 @@ public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Moj
private String finalName;

/**
* The Jar archiver.
* The JAR archiver.
*/
@Inject
private Map<String, Archiver> archivers;

/**
* The {@link Project}.
* The Maven project.
*/
@Inject
private Project project;

/**
* The {@link Session}.
* The session.
*/
@Inject
private Session session;
Expand All @@ -109,33 +108,20 @@ public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Moj
@Parameter
private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();

/**
* Using this property will fail your build cause it has been removed from the plugin configuration. See the menu entry
* <a href="https://maven.apache.org/plugins/maven-jar-plugin/">Using Your Own Manifest File</a> for the
* plugin.
*
* @deprecated For version 3.0.0 this parameter is only defined here to break the build if you use it!
*/
@Parameter(property = "jar.useDefaultManifestFile", defaultValue = "false")
@Deprecated
private boolean useDefaultManifestFile;

/**
*
*/
@Inject
private ProjectManager projectManager;

/**
* Require the jar plugin to build a new JAR even if none of the contents appear to have changed. By default, this
* plugin looks to see if the output jar exists and inputs have not changed. If these conditions are true, the
* plugin skips creation of the jar. This does not work when other plugins, like the maven-shade-plugin, are
* configured to post-process the jar. This plugin can not detect the post-processing, and so leaves the
* post-processed jar in place. This can lead to failures when those plugins do not expect to find their own output
* as an input. Set this parameter to <tt>true</tt> to avoid these problems by forcing this plugin to recreate the
* jar every time.<br/>
* Starting with <b>3.0.0</b> the property has been renamed from <code>jar.forceCreation</code> to
* <code>maven.jar.forceCreation</code>.
* Require the jar plugin to build a new JAR even if none of the contents appear to have changed.
* By default, this plugin looks to see if the output JAR exists and inputs have not changed.
* If these conditions are true, the plugin skips creation of the JAR file.
* This does not work when other plugins, like the maven-shade-plugin, are configured to post-process the JAR.
* This plugin can not detect the post-processing, and so leaves the post-processed JAR file in place.
* This can lead to failures when those plugins do not expect to find their own output as an input.
* Set this parameter to {@code true} to avoid these problems by forcing this plugin to recreate the JAR every time.
*
* <p>Starting with <b>3.0.0</b> the property has been renamed from {@code jar.forceCreation}
* to {@code maven.jar.forceCreation}.</p>
*/
@Parameter(property = "maven.jar.forceCreation", defaultValue = "false")
private boolean forceCreation;
Expand All @@ -147,9 +133,10 @@ public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Moj
private boolean skipIfEmpty;

/**
* Timestamp for reproducible output archive entries, either formatted as ISO 8601 extended offset date-time
* Timestamp for reproducible output archive entries.
* This is either formatted as ISO 8601 extended offset date-time
* (e.g. in UTC such as '2011-12-03T10:15:30Z' or with an offset '2019-10-05T20:37:42+06:00'),
* or as an int representing seconds since the epoch
* or as an integer representing seconds since the epoch
* (like <a href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).
*
* @since 3.2.0
Expand All @@ -158,76 +145,79 @@ public abstract class AbstractJarMojo implements org.apache.maven.api.plugin.Moj
private String outputTimestamp;

/**
* Whether to detect multi-release JAR files.
* If the JAR contains the {@code META-INF/versions} directory it will be detected as a multi-release JAR file
* ("MRJAR"), adding the {@code Multi-Release: true} attribute to the main section of the JAR MANIFEST.MF.
* ("MRJAR"), adding the {@code Multi-Release: true} attribute to the main section of the JAR {@code MANIFEST.MF}.
*
* @since 3.4.0
*/
@Parameter(property = "maven.jar.detectMultiReleaseJar", defaultValue = "true")
private boolean detectMultiReleaseJar;

/**
* The mojo logger
* The <abbr>MOJO</abbr> logger.
*/
@Inject
private Log log;

/**
* Return the specific output directory to serve as the root for the archive.
* @return get classes directory.
* Creates a new <abbr>MOJO</abbr>.
*/
protected AbstractJarMojo() {}

/**
* {@return the specific output directory to serve as the root for the archive}
*/
protected abstract Path getClassesDirectory();

/**
* Return the {@link #project MavenProject}
* Return the {@linkplain #project Maven project}.
*
* @return the MavenProject.
* @return the Maven project
*/
protected final Project getProject() {
return project;
}

/**
* {@return the <abbr>MOJO</abbr> logger}
*/
protected final Log getLog() {
return log;
}

/**
* Overload this to produce a jar with another classifier, for example a test-jar.
* @return get the classifier.
* {@return the classifier of the JAR file to produce}
* This is usually null or empty for the main artifact, or {@code "tests"} for the JAR file of test code.
*/
protected abstract String getClassifier();

/**
* Overload this to produce a test-jar, for example.
* @return return the type.
* {@return the type of the JAR file to produce}
* This is usually {@code "jar"} for the main artifact, or {@code "test-jar"} for the JAR file of test code.
*/
protected abstract String getType();

/**
* Returns the Jar file to generate, based on an optional classifier.
* Returns the JAR file to generate, based on an optional classifier.
*
* @param basedir the output directory
* @param resultFinalName the name of the ear file
* @param classifier an optional classifier
* @return the file to generate
*/
protected Path getJarFile(Path basedir, String resultFinalName, String classifier) {
if (basedir == null) {
throw new IllegalArgumentException("basedir is not allowed to be null");
}
if (resultFinalName == null) {
throw new IllegalArgumentException("finalName is not allowed to be null");
}

String fileName = resultFinalName + (hasClassifier() ? "-" + classifier : "") + ".jar";

Objects.requireNonNull(basedir, "basedir is not allowed to be null");
Objects.requireNonNull(resultFinalName, "finalName is not allowed to be null");
String fileName = resultFinalName + (hasClassifier(classifier) ? '-' + classifier : "") + ".jar";
return basedir.resolve(fileName);
}

/**
* Generates the JAR.
* @return The instance of File for the created archive file.
* @throws MojoException in case of an error.
*
* @return the path to the created archive file
* @throws MojoException in case of an error
*/
public Path createArchive() throws MojoException {
Path jarFile = getJarFile(outputDirectory, finalName, getClassifier());
Expand All @@ -242,9 +232,10 @@ public Path createArchive() throws MojoException {

if (detectMultiReleaseJar
&& Arrays.stream(includedFiles)
.anyMatch(p -> p.startsWith("META-INF" + SEPARATOR + "versions" + SEPARATOR))) {
.anyMatch(
p -> p.startsWith("META-INF" + File.separatorChar + "versions" + File.separatorChar))) {
getLog().debug("Adding 'Multi-Release: true' manifest entry.");
archive.addManifestEntry("Multi-Release", "true");
archive.addManifestEntry(Attributes.Name.MULTI_RELEASE.toString(), "true");
}

// May give false positives if the files is named as module descriptor
Expand Down Expand Up @@ -291,27 +282,23 @@ public Path createArchive() throws MojoException {

/**
* Generates the JAR.
* @throws MojoException in case of an error.
*
* @throws MojoException in case of an error
*/
@Override
public void execute() throws MojoException {
if (useDefaultManifestFile) {
throw new MojoException("You are using 'useDefaultManifestFile' which has been removed"
+ " from the maven-jar-plugin. "
+ "Please see the link >>Using Your Own Manifest File<< on the plugin site.");
}

if (skipIfEmpty && isEmpty(getClassesDirectory())) {
getLog().info("Skipping packaging of the " + getType());
getLog().info(String.format("Skipping packaging of the %s.", getType()));
} else {
Path jarFile = createArchive();
ProducedArtifact artifact;
if (hasClassifier()) {
String classifier = getClassifier();
if (hasClassifier(classifier)) {
artifact = session.createProducedArtifact(
project.getGroupId(),
project.getArtifactId(),
project.getVersion(),
getClassifier(),
classifier,
null,
getType());
} else {
Expand All @@ -325,12 +312,12 @@ public void execute() throws MojoException {
}
}

private boolean isEmpty(Path directory) {
private static boolean isEmpty(Path directory) {
if (!Files.isDirectory(directory)) {
return true;
}
try (Stream<Path> children = Files.list(directory)) {
return !children.findAny().isPresent();
return children.findAny().isEmpty();
} catch (IOException e) {
throw new MavenArchiverException("Unable to access directory", e);
}
Expand All @@ -344,10 +331,11 @@ private boolean projectHasAlreadySetAnArtifact() {
/**
* Return {@code true} in case where the classifier is not {@code null} and contains something else than white spaces.
*
* @return {@code true} if the classifier is set.
* @param classifier the classifier to verify
* @return {@code true} if the classifier is set
*/
protected boolean hasClassifier() {
return getClassifier() != null && !getClassifier().trim().isEmpty();
private static boolean hasClassifier(String classifier) {
return classifier != null && !classifier.isBlank();
}

private String[] getIncludes() {
Expand Down
Loading
Loading