Difference between revisions of "MNG-6189"

From BITPlan Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
You get this error if your maven pom.xml configuration looks like this:
 
You get this error if your maven pom.xml configuration looks like this:
 
=== original pom.xml ===
 
=== original pom.xml ===
<source lang='xml' highlight="9-11,20-21">
+
<source lang='xml' highlight="9-11,21-22">
 
<project>
 
<project>
 
   <build>
 
   <build>
Line 34: Line 34:
 
             </plugin>
 
             </plugin>
 
             <plugin>
 
             <plugin>
             <!-- report plugin 1 -->
+
             <!-- report plugin 2 -->
 
             ...
 
             ...
 
             </plugin>
 
             </plugin>
 +
            ...
 
           <reportPlugins>
 
           <reportPlugins>
 
         </configuration>
 
         </configuration>
Line 44: Line 45:
 
</project>
 
</project>
 
</source>
 
</source>
 +
 
=== upgrade org.apache.maven.plugins version ===
 
=== upgrade org.apache.maven.plugins version ===
 
You first might want to upgrade your plugin version. You can find the current version at
 
You first might want to upgrade your plugin version. You can find the current version at
Line 84: Line 86:
 
</source>
 
</source>
 
=== cut & paste the list of report plugins ===
 
=== cut & paste the list of report plugins ===
Now cut&paste the list of report plugins from the configuration above into it like this:
+
Now add a  '''<plugins></plugins>''' node to the reporting node cut&paste the list of report plugins from the configuration above into it like this:
<source lang='xml' highlight="3-10">
+
<source lang='xml' highlight="3-13">
 
<project>
 
<project>
 
   <reporting>
 
   <reporting>
     <plugin>
+
     <plugins>
      <!-- report plugin 1 -->
 
      ...
 
      </plugin>
 
 
       <plugin>
 
       <plugin>
      <!-- report plugin 2 -->
+
        <!-- report plugin 1 -->
      ...
+
        ...
      </plugin>
+
        </plugin>
 +
        <plugin>
 +
        <!-- report plugin 2 -->
 +
        ...
 +
        </plugin>
 +
        ...
 +
    <plugins>
 
   </reporting>
 
   </reporting>
 
</project>
 
</project>

Latest revision as of 06:31, 15 October 2017

As discussed in:

https://stackoverflow.com/questions/46742407/some-problems-were-encountered-while-building-the-effective-model-for when you see the warning:

[WARNING] 
[WARNING] Some problems were encountered while building the effective model for com.bitplan.antlr:com.bitplan.antlr:jar:0.0.1
[WARNING] Reporting configuration should be done in <reporting> section, not in maven-site-plugin <configuration> as reportPlugins parameter. @ line 213, column 20
[WARNING] 
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING] 

You have run into an issue that is explained in:

What to do?

You get this error if your maven pom.xml configuration looks like this:

original pom.xml

<project>
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.0</version>
        <configuration>
          <!-- configuration of reports to be included in site -->
          <reportPlugins>
            <plugin>
            <!-- report plugin 1 -->
            ...
            </plugin>
            <plugin>
            <!-- report plugin 2 -->
            ...
            </plugin>
            ...
          <reportPlugins>
        </configuration>
      </plugin>
    <plugins>
  </build>
</project>

upgrade org.apache.maven.plugins version

You first might want to upgrade your plugin version. You can find the current version at search.maven.org

<project>
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.6</version>
        <configuration>
          <!-- configuration of reports to be included in site -->
          <reportPlugins>
            <plugin>
            <!-- report plugin 1 -->
            ...
            </plugin>
            <plugin>
            <!-- report plugin 1 -->
            ...
            </plugin>
          <reportPlugins>
        </configuration>
      </plugin>
    <plugins>
  </build>
</project>

add a reporting node

Then you might want to create a new node <reporting></reporting> (it it does not exist yet) directly unter the <project><project> node:

<project>
  <reporting>
  </reporting>
</project>

cut & paste the list of report plugins

Now add a <plugins></plugins> node to the reporting node cut&paste the list of report plugins from the configuration above into it like this:

<project>
  <reporting>
    <plugins>
      <plugin>
        <!-- report plugin 1 -->
        ...
        </plugin>
        <plugin>
        <!-- report plugin 2 -->
        ...
        </plugin>
        ...
    <plugins>
  </reporting>
</project>

remove configuration node if empty

In the plugins list in the build part only:

<project>
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.0</version>
      </plugin>
    <plugins>
  </build>
</project>

keep configuration node if non empty

is needed or if you have any non report configurations:

<project>
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.6</version>
        <configuration>
        ...
        </configuration>
      </plugin>
    <plugins>
  </build>
</project>

Check result

run

mvn site

to check that the error went away and the site plugin is working as expected.

Example

See https://github.com/BITPlan/com.bitplan.antlr/blob/master/pom.xml for a complete pom.xml example