Skip to content

[MPH-217] Ensure packaging is always shown in effective-pom output #405

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

Draft
elharo wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

[MPH-217] Ensure packaging is always shown in effective-pom output #405

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
d7b316a
[MPH-217] Ensure packaging is always shown in effective-pom output
Jul 29, 2026
bdedfe9
Merge remote-tracking branch 'origin/master' into pr405
elharo Aug 7, 2026
f5e9557
ci: re-run workflow
elharo Aug 7, 2026
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
18 changes: 18 additions & 0 deletions src/it/projects/effective-pom-packaging/invoker.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:effective-pom
29 changes: 29 additions & 0 deletions src/it/projects/effective-pom-packaging/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

<project>
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.its.help</groupId>
<artifactId>mph-217</artifactId>
<version>1.0-SNAPSHOT</version>
<!-- no packaging set, should default to "jar" -->
</project>
25 changes: 25 additions & 0 deletions src/it/projects/effective-pom-packaging/verify.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
def buildLog = new File(basedir, 'build.log');
assert buildLog.exists()

def LS = System.getProperty("line.separator")
assert buildLog.text.find(
'(?s)' +
' <packaging>jar</packaging>') != null
Comment on lines +22 to +25
10 changes: 10 additions & 0 deletions src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,16 @@ private void writeEffectivePom(MavenProject project, XMLWriter writer) throws Mo
// This removes the XML declaration written by MavenXpp3Writer
String effectivePom = prettyFormat(sWriter.toString(), null, true);

// MavenXpp3Writer omits packaging when it is null or "jar" (the default).
// Ensure it is always present so users can see the effective packaging value.
if (pom.getPackaging() == null || "jar".equals(pom.getPackaging())) {
String packaging = pom.getPackaging() != null ? pom.getPackaging() : project.getPackaging();
String packagingTag = " <packaging>" + packaging + "</packaging>";
if (!effectivePom.contains(packagingTag)) {
effectivePom = effectivePom.replace("</version>" + LS, "</version>" + LS + packagingTag + LS);

@pzygielo pzygielo Aug 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If given project has parent, like

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>...</groupId>
    <artifactId>...</artifactId>
    <version>0.1-SNAPSHOT</version>
  </parent>
  <groupId>...</groupId>
  <artifactId>..</artifactId>
  <version>0.1-SNAPSHOT</version>
  ...

which </version> will be replaced in l. 206?

@pzygielo pzygielo Aug 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated IT presented here with:

diff --git a/src/it/projects/effective-pom-packaging/pom.xml b/src/it/projects/effective-pom-packaging/pom.xml
index 6622e25..a97aed6 100644
--- a/src/it/projects/effective-pom-packaging/pom.xml
+++ b/src/it/projects/effective-pom-packaging/pom.xml
@@ -21,7 +21,11 @@ under the License.
 
 <project>
   <modelVersion>4.0.0</modelVersion>
-
+<parent>
+<groupId>org.apache.maven</groupId>
+<artifactId>maven-parent</artifactId>
+<version>49</version>
+</parent>
   <groupId>org.apache.maven.its.help</groupId>
   <artifactId>mph-217</artifactId>
   <version>1.0-SNAPSHOT</version>

And here is test result: SUCCESS.

But here is the goal result:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-parent</artifactId>
    <version>49</version>
    <packaging>jar</packaging>
  </parent>
  <groupId>org.apache.maven.its.help</groupId>
  <artifactId>mph-217</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

This is of course non-sense for parent.

And, perhaps according to String.replace javadoc (Replaces each substring of this string that matches the literal target sequence), every </version>, including plugins' - has explicit <packaging>jar</packaging> companion now.

I don't think it's correct...

@pzygielo pzygielo Aug 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To clarify above - even without any modification to this PR - manual inspection of target/it/effective-pom-packaging/build.log shows that too much is done to the effective pom.

Perhaps src/it/projects/effective-pom-packaging/verify.groovy could be fixed to check that only expected changes are there (i.e. no unexpected changes are).

@elharo elharo Aug 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point and a good reminder of why regexes are dangerous when processing XML. There are other failure modes here too. I might take a whirl at fixing this with some real XML.

}
}
Comment on lines +200 to +208

writeComment(writer, "Effective POM for project '" + project.getId() + "'");

writer.writeMarkup(effectivePom);
Expand Down
Loading