Multi-Module Maven with github pages

Wolfgang Fahl

Motivation

The issues

led to the creation of the example project:

https://github.com/BITPlan/com.bitplan.multimodule which uses
https://github.com/BITPlan/com.bitplan.pom for the parent pom definition

in which the github maven site plugin is defined with the configuration

<!-- git hub site plugin https://github.com/github/maven-plugins -->
<plugin>
  <groupId>com.github.github</groupId>
  <artifactId>site-maven-plugin</artifactId>
  <version>${site-maven-plugin.version}</version>
  <configuration>
    <message>Creating site for ${github.owner} ${github.project}
      ${project.version}</message>
    <repositoryName>${github.project}</repositoryName>      <!-- github repo name -->
    <repositoryOwner>${github.owner}</repositoryOwner>    <!-- github username -->
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>site</goal>
      </goals>
      <phase>site</phase>
    </execution>
  </executions>
</plugin>

Following the suggestion of https://stackoverflow.com/a/19336536/1497139 led to adding

  <distributionManagement>
    <site>
      <id>${project.artifactId}-site</id>
      <url>${project.baseUri}</url>
    </site>
  </distributionManagement>

to the parent pom.xml

mvn clean site 
... wait a long while ...

[INFO] Multi-Module ....................................... SUCCESS [04:22 min]
[INFO] Multi-Module 1 ..................................... SUCCESS [04:09 min]
[INFO] Multi-Module 2 ..................................... SUCCESS [04:09 min]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12:42 min

and you end up with Module 2 overriding the results of the Multi-Module and Module 1 results

Motivation[edit]

The issues

led to the creation of the example project:

https://github.com/BITPlan/com.bitplan.multimodule which uses
https://github.com/BITPlan/com.bitplan.pom for the parent pom definition

in which the github maven site plugin is defined with the configuration

<!-- git hub site plugin https://github.com/github/maven-plugins -->
<plugin>
  <groupId>com.github.github</groupId>
  <artifactId>site-maven-plugin</artifactId>
  <version>${site-maven-plugin.version}</version>
  <configuration>
    <message>Creating site for ${github.owner} ${github.project}
      ${project.version}</message>
    <repositoryName>${github.project}</repositoryName>      <!-- github repo name -->
    <repositoryOwner>${github.owner}</repositoryOwner>    <!-- github username -->
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>site</goal>
      </goals>
      <phase>site</phase>
    </execution>
  </executions>
</plugin>

Following the suggestion of https://stackoverflow.com/a/19336536/1497139 led to adding

  <distributionManagement>
    <site>
      <id>${project.artifactId}-site</id>
      <url>${project.baseUri}</url>
    </site>
  </distributionManagement>

to the parent pom.xml

mvn clean site 
... wait a long while ...

[INFO] Multi-Module ....................................... SUCCESS [04:22 min]
[INFO] Multi-Module 1 ..................................... SUCCESS [04:09 min]
[INFO] Multi-Module 2 ..................................... SUCCESS [04:09 min]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12:42 min

and you end up with Module 2 overriding the results of the Multi-Module and Module 1 results

Is it a bug or a feature?[edit]

Its a bug!

Whats the work-around?[edit]

Do not use the plugin!
git clone or pull the gh-pages to a local folder
mvn site:stage to a temporary staging directory
rsync the results into the git local folder
check in the local folder
have a cup of coffee or drink a beer / be happy ✓

Tests	Fehler	Fehlschläge	Ausgelassen	Erfolgsrate	Zeit
2	0	0	0	100%	0,002

Paket	Tests	Fehler	Fehlschläge	Ausgelassen	Erfolgsrate	Zeit
com.bitplan.multimodule	2	0	0	0	100%	0,002

	Klasse	Tests	Fehler	Fehlschläge	Ausgelassen	Erfolgsrate	Zeit
	TestMain	1	0	0	0	100%	0,001
	TestMain	1	0	0	0	100%	0,001

${project.baseUri}[edit]

/project/distributionManagement/site/url=${project.baseUri}
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/target/site
[INFO]    >>> to file:///tmp/stage/4site/../com.bitplan.multimodule/com.bitplan.multimodule
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/multimodule-module1/target/site
[INFO]    >>> to file:///tmp/stage/4site/../com.bitplan.multimodule/multimodule-module1/com.bitplan.multimodule/multimodule1
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/multimodule-module2/target/site
[INFO]    >>> to file:///tmp/stage/4site/../com.bitplan.multimodule/multimodule-module2/com.bitplan.multimodule/multimodule2

the multimodule index file is at /tmp/stage/com.bitplan.multimodule/com.bitplan.multimodule/index.html ✓
inter-module links work and the main parent module is at /tmp/stage/com.bitplan.pom/index.html ✓

${project.artifactId}[edit]

/project/distributionManagement/site/url=${project.artifactId}

failed: Base URI is not absolute: com.bitplan.pom -> [Help 1]

https://${github.owner}.github.io/${project.artifactId}[edit]

/project/distributionManagement/site/url=https://${github.owner}.github.io/${project.artifactId}
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/target/site
[INFO]    >>> to file:///tmp/stage/4site/../com.bitplan.multimodule/com.bitplan.multimodule
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/multimodule-module1/target/site
[INFO]    >>> to file:///tmp/stage/4site/../multimodule1/com.bitplan.multimodule/multimodule1
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.multimodule/multimodule-module2/target/site
[INFO]    >>> to file:///tmp/stage/4site/../multimodule2/com.bitplan.multimodule/multimodule2

Same result as the working result above ..

the multimodule index file is at /tmp/stage/com.bitplan.multimodule/com.bitplan.multimodule/index.html ✓
inter-module links work and the main parent module is at /tmp/stage/com.bitplan.pom/index.html ✓

Test with non -module pom based project[edit]

/project/distributionManagement/site/url=https://${github.owner}.github.io/${project.artifactId}
[INFO] Pushing /Users/wf/Documents/workspace/com.bitplan.fritzbox/target/site
[INFO]    >>> to file:///tmp/stage/4site/../com.bitplan.fritzbox/com.bitplan.fritzbox

Example pom.xml files[edit]

Stackoverflow questions[edit]

site/github pages[edit]

aggregating reports[edit]

conditional parent pom[edit]

http://stackoverflow.com/questions/35856843/maven-conditional-parent-pom
- https://github.com/m2spring/wild-inhouse-hybrid-example/tree/property-approach

Multi-Module Maven with github pages Wolfgang Fahl

site/github pages[edit]

aggregating reports[edit]

conditional parent pom[edit]

http://stackoverflow.com/questions/35856843/maven-conditional-parent-pom
- https://github.com/m2spring/wild-inhouse-hybrid-example/tree/property-approach

Links[edit]

https://wiki.jenkins.io/display/JENKINS/Site+Creation+and+Deployment

Multi-Module Maven with github pages

${project.baseUri}[edit]

${project.artifactId}[edit]

https://${github.owner}.github.io/${project.artifactId}[edit]

Test with non -module pom based project[edit]

Example pom.xml files[edit]

Stackoverflow questions[edit]

site/github pages[edit]

aggregating reports[edit]

conditional parent pom[edit]

site/github pages[edit]

aggregating reports[edit]

conditional parent pom[edit]

Links[edit]

Documentation[edit]