Author: davide
Date: Fri Nov 21 14:36:15 2014
New Revision: 1640922
URL: http://svn.apache.org/r1640922
Log:
OAK-2275 - mvn site and site-deploy does not work as expected
committing a slightly modified Michael's patch. Thanks!
Modified:
jackrabbit/oak/trunk/oak-doc/README.md
jackrabbit/oak/trunk/oak-parent/pom.xml
jackrabbit/oak/trunk/pom.xml
Modified: jackrabbit/oak/trunk/oak-doc/README.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/README.md?rev=1640922&r1=1640921&r2=1640922&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/README.md (original)
+++ jackrabbit/oak/trunk/oak-doc/README.md Fri Nov 21 14:36:15 2014
@@ -22,25 +22,38 @@ The Oak documentation lives as Markdown
that it easy to view e.g. from GitHub. Alternatively the Maven site plugin
can be used to build and deploy a web site as follows:
-From the reactor use
+From the reactor do
- mvn site
+ mvn clean -Pdoc
-to build the site without Javadoc or
+to clean any existing site,
- mvn site -Psite-with-javadoc
+ mvn site -Pdoc
-to build the site with Javadoc. Review the site at `oak-doc/target/site`.
+to build the site **without** Javadoc, and optionally
+
+ mvn site -Pjavadoc
+
+to add Javadoc.
+
+ mvn site -Pdoc,javadoc
+
+to generate **both** site and javadocs. Review the site at
+`oak-doc/target/site`.
Then deploy the site to `http://jackrabbit.apache.org/oak/docs/` using
- mvn site-deploy
+ mvn site-deploy -Pdoc
Finally review the site at `http://jackrabbit.apache.org/oak/docs/index.html`.
-To skip the final commit use `-Dscmpublish.skipCheckin=true`. You can then
-review all pending changes in `oak-doc/target/scmpublish-checkout` and follow
-up with `svn commit` manually.
+To skip the final commit during the deploy phase you can specify
+`-Dscmpublish.skipCheckin=true`. You can then review all pending changes in
+`oak-doc/target/scmpublish-checkout` and follow up with `svn commit` manually.
+
+*Note*: `mvn clean` needs to be run as a separate command as otherwise
generating
+the Javadocs would not work correctly due to issues with module ordering.
Every committer should be able to deploy the site. No fiddling with
credentials needed since deployment is done via svn commit to
`https://svn.apache.org/repos/asf/jackrabbit/site/live/oak/docs`.
+
Modified: jackrabbit/oak/trunk/oak-parent/pom.xml
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-parent/pom.xml?rev=1640922&r1=1640921&r2=1640922&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-parent/pom.xml (original)
+++ jackrabbit/oak/trunk/oak-parent/pom.xml Fri Nov 21 14:36:15 2014
@@ -528,30 +528,6 @@
</build>
</profile>
<profile>
- <id>site-with-javadoc</id>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <executions>
- <execution>
- <id>aggregate</id>
- <goals>
- <goal>aggregate</goal>
- </goals>
- <phase>site</phase>
- </execution>
- </executions>
- <configuration>
-
<reportOutputDirectory>${basedir}/oak-doc/target/site</reportOutputDirectory>
- <additionalparam>-notimestamp</additionalparam>
- </configuration>
- </plugin>
- </plugins>
- </build>
- </profile>
- <profile>
<id>rdb-mysql</id>
<dependencies>
<dependency>
Modified: jackrabbit/oak/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/pom.xml?rev=1640922&r1=1640921&r2=1640922&view=diff
==============================================================================
--- jackrabbit/oak/trunk/pom.xml (original)
+++ jackrabbit/oak/trunk/pom.xml Fri Nov 21 14:36:15 2014
@@ -100,6 +100,36 @@
<profiles>
<profile>
+ <id>doc</id>
+ <modules>
+ <module>oak-doc</module>
+ </modules>
+ </profile>
+ <profile>
+ <id>javadoc</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>aggregate</id>
+ <goals>
+ <goal>aggregate</goal>
+ </goals>
+ <phase>site</phase>
+ </execution>
+ </executions>
+ <configuration>
+
<reportOutputDirectory>${basedir}/oak-doc/target/site</reportOutputDirectory>
+ <additionalparam>-notimestamp</additionalparam>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
<id>apache-release</id>
<properties>
<keyfile>${user.home}/.ssh/id_rsa</keyfile>
