Skip to content

Commit

Permalink
[MNG-8473] Site fixes (#2010)
Browse files Browse the repository at this point in the history 
Maven4 site cleanup: make all new modules generating models also document them, expose them all and redirect all links to new documentation.

Lifecycle is the only thing missing, as it is generated on the fly, there is no more source to "point at"...

---

https://issues.apache.org/jira/browse/MNG-8473
  • Loading branch information
@cstamas
cstamas authored Jan 8, 2025
1 parent 7546361 commit 71c662f
Show file tree
Hide file tree
Showing 14 changed files with 166 additions and 197 deletions.
2 changes: 2 additions & 0 deletions api/maven-api-cli/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@
<id>modello</id>
<goals>
<goal>velocity</goal>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-sources</phase>
</execution>
</executions>
</plugin>
Expand Down
42 changes: 15 additions & 27 deletions api/maven-api-metadata/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,40 +42,28 @@ under the License.
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<configuration>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<version>1.2.0</version>
<models>
<model>src/main/mdo/metadata.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.metadata</param>
</params>
</configuration>
<executions>
<execution>
<id>plugin</id>
<id>modello</id>
<goals>
<goal>velocity</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<version>1.2.0</version>
<models>
<model>src/main/mdo/metadata.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.metadata</param>
</params>
</configuration>
</execution>
<execution>
<id>plugin-doc</id>
<goals>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<version>1.2.0</version>
<models>
<model>src/main/mdo/metadata.mdo</model>
</models>
</configuration>
<phase>generate-sources</phase>
</execution>
</executions>
</plugin>
Expand Down
33 changes: 18 additions & 15 deletions api/maven-api-model/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,26 +47,29 @@ under the License.
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<configuration>
<version>4.1.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/maven.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.model</param>
<param>isMavenModel=true</param>
</params>
</configuration>
<executions>
<execution>
<id>velocity</id>
<id>modello</id>
<goals>
<goal>velocity</goal>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<configuration>
<version>4.1.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/maven.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.model</param>
<param>isMavenModel=true</param>
</params>
</configuration>
<phase>generate-sources</phase>
</execution>
</executions>
</plugin>
Expand Down
34 changes: 5 additions & 29 deletions api/maven-api-plugin/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ under the License.
<artifactId>modello-maven-plugin</artifactId>
<executions>
<execution>
<id>plugin</id>
<id>modello-plugin</id>
<goals>
<goal>velocity</goal>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
Expand All @@ -73,24 +75,12 @@ under the License.
</configuration>
</execution>
<execution>
<id>plugin-doc</id>
<id>modello-lifecycle</id>
<goals>
<goal>velocity</goal>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<version>2.0.0</version>
<models>
<model>src/main/mdo/plugin.mdo</model>
</models>
</configuration>
</execution>
<execution>
<id>lifecycle</id>
<goals>
<goal>velocity</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
Expand All @@ -106,20 +96,6 @@ under the License.
</params>
</configuration>
</execution>
<execution>
<id>lifecycle-doc</id>
<goals>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<version>1.0.0</version>
<models>
<model>src/main/mdo/lifecycle.mdo</model>
</models>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
Expand Down
43 changes: 16 additions & 27 deletions api/maven-api-settings/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,41 +53,30 @@ under the License.
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<configuration>
<version>2.0.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/settings.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.settings</param>
<param>locationTracking=true</param>
<param>generateLocationClasses=true</param>
</params>
</configuration>
<executions>
<execution>
<id>velocity</id>
<id>modello</id>
<goals>
<goal>velocity</goal>
</goals>
<configuration>
<version>2.0.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/settings.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.settings</param>
<param>locationTracking=true</param>
<param>generateLocationClasses=true</param>
</params>
</configuration>
</execution>
<execution>
<id>modello-site-docs</id>
<goals>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<version>2.0.0</version>
<models>
<model>src/main/mdo/settings.mdo</model>
</models>
</configuration>
</execution>
</executions>
</plugin>
Expand Down
35 changes: 19 additions & 16 deletions api/maven-api-toolchain/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,27 +46,30 @@ under the License.
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<configuration>
<version>1.2.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/toolchains.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.toolchain</param>
<param>locationTracking=true</param>
<param>generateLocationClasses=true</param>
</params>
</configuration>
<executions>
<execution>
<id>velocity</id>
<id>modello</id>
<goals>
<goal>velocity</goal>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<configuration>
<version>1.2.0</version>
<velocityBasedir>${project.basedir}/../../src/mdo</velocityBasedir>
<models>
<model>src/main/mdo/toolchains.mdo</model>
</models>
<templates>
<template>model.vm</template>
</templates>
<params>
<param>packageModelV4=org.apache.maven.api.toolchain</param>
<param>locationTracking=true</param>
<param>generateLocationClasses=true</param>
</params>
</configuration>
<phase>generate-resources</phase>
</execution>
</executions>
</plugin>
Expand Down
21 changes: 0 additions & 21 deletions api/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,6 @@
<project.directory>api</project.directory>
</properties>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<executions>
<execution>
<id>modello-site-docs</id>
<goals>
<goal>xdoc</goal>
<goal>xsd</goal>
</goals>
<phase>none</phase>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
</build>

<profiles>
<profile>
<id>reporting</id>
Expand Down
14 changes: 0 additions & 14 deletions compat/maven-model/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,20 +95,6 @@ under the License.
</params>
</configuration>
<executions>
<execution>
<id>modello-site-docs</id>
<goals>
<goal>xdoc</goal>
</goals>
<phase>pre-site</phase>
</execution>
<execution>
<id>modello-schema</id>
<goals>
<goal>xsd</goal>
</goals>
<phase>generate-resources</phase>
</execution>
<execution>
<id>model-v3</id>
<goals>
Expand Down
25 changes: 0 additions & 25 deletions impl/maven-core/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,31 +215,6 @@ under the License.
<groupId>org.eclipse.sisu</groupId>
<artifactId>sisu-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.modello</groupId>
<artifactId>modello-maven-plugin</artifactId>
<configuration>
<version>1.1.0</version>
<!-- This is a required attribute and is intentionally left empty -->
<models />
</configuration>
<executions>
<execution>
<!-- This step is required to generate xdoc, and does not generate java code -->
<id>modello-site-doc</id>
<goals>
<goal>xdoc</goal>
</goals>
<phase>pre-site</phase>
<configuration>
<version>1.0.0</version>
<models>
<model>src/main/mdo/extension.mdo</model>
</models>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>buildnumber-maven-plugin</artifactId>
Expand Down
Loading

0 comments on commit 71c662f

Please sign in to comment.