You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by so...@apache.org on 2009/01/09 00:46:03 UTC
svn commit: r732875 - in /myfaces/portlet-bridge/core/trunk: api/pom.xml
build-api-javadoc.sh pom.xml src/site/apt/index.apt.vm
Author: sobryan
Date: Thu Jan 8 15:46:03 2009
New Revision: 732875
URL: http://svn.apache.org/viewvc?rev=732875&view=rev
Log:
Some changes to site generation so that the site can be generated from the trunks but the API documentation can be taken from the latest release.
*Removed javadoc from the reports on the base pom file
*Added javadoc to the buld on the API project
*Added a script which will be run by continuum
Added:
myfaces/portlet-bridge/core/trunk/build-api-javadoc.sh
Modified:
myfaces/portlet-bridge/core/trunk/api/pom.xml
myfaces/portlet-bridge/core/trunk/pom.xml
myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm
Modified: myfaces/portlet-bridge/core/trunk/api/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/portlet-bridge/core/trunk/api/pom.xml?rev=732875&r1=732874&r2=732875&view=diff
==============================================================================
--- myfaces/portlet-bridge/core/trunk/api/pom.xml (original)
+++ myfaces/portlet-bridge/core/trunk/api/pom.xml Thu Jan 8 15:46:03 2009
@@ -16,7 +16,7 @@
-->
<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 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
- <name>MyFaces Portlet Bridge 1.0 API</name>
+ <name>MyFaces Portlet Bridge API</name>
<artifactId>portlet-bridge-api</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
@@ -58,16 +58,33 @@
<build>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.5</version>
+ <configuration>
+ <doctitle>MyFaces Portlet Bridge ${project.version} API</doctitle>
+ <windowtitle>MyFaces Portlet Bridge ${project.version} API</windowtitle>
+ <aggregate>false</aggregate>
+ <linksource>true</linksource>
+ <breakiterator>true</breakiterator>
+ <quiet>true</quiet>
+ <verbose>false</verbose>
+ <source>${jdk.version}</source>
+ <charset>UTF-8</charset>
+ <links>
+ <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
+ <link>http://java.sun.com/javaee/javaserverfaces/1.2_MR1/docs/api</link>
+ <link>http://portals.apache.org/pluto/portlet-1.0-apidocs/</link>
+ </links>
+ </configuration>
+ </plugin>
<!-- Allows building of jdev projects (jdev:jdev target) -->
<!-- TODO: This is an artifical dependancy on Trinidad, should it be removed? -->
<plugin>
<groupId>org.apache.myfaces.trinidadbuild</groupId>
<artifactId>maven-jdev-plugin</artifactId>
- </plugin>
-
- <plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- </plugin>
+ </plugin>
</plugins>
- </build>
+ </build>
</project>
Added: myfaces/portlet-bridge/core/trunk/build-api-javadoc.sh
URL: http://svn.apache.org/viewvc/myfaces/portlet-bridge/core/trunk/build-api-javadoc.sh?rev=732875&view=auto
==============================================================================
--- myfaces/portlet-bridge/core/trunk/build-api-javadoc.sh (added)
+++ myfaces/portlet-bridge/core/trunk/build-api-javadoc.sh Thu Jan 8 15:46:03 2009
@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+# 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.
+
+usage()
+{
+ echo "Usage: $0"
+ exit 1
+}
+
+if [ -r ./settings ]
+then
+ source ./settings
+fi
+
+##############################################################################
+# Do some checks of the enviroment
+##############################################################################
+
+if [ -z "$JAVA_HOME" ]
+then
+ echo "JAVA_HOME must be set."
+fi
+
+if [ -z "`which java`" ]
+then
+ echo "Could not find 'java' in the path."
+ echo "PATH: $PATH"
+ exit 1
+fi
+
+
+##############################################################################
+# Build
+##############################################################################
+echo "Building Portlet Bridge Javadoc for site."
+mvn clean install -DsiteJavadoc --batch-mode
+cd api
+mvn javadoc:javadoc -DsiteJavadoc --batch-mode
+echo "Removing Old Javadocs"
+rm -Rf /www/myfaces.apache.org/portlet-bridge/1.0/api/apidocs
+echo "Copying new JavaDocs
+mv target/site/apidocs /www/myfaces.apache.org/portlet-bridge/1.0/api
Modified: myfaces/portlet-bridge/core/trunk/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/portlet-bridge/core/trunk/pom.xml?rev=732875&r1=732874&r2=732875&view=diff
==============================================================================
--- myfaces/portlet-bridge/core/trunk/pom.xml (original)
+++ myfaces/portlet-bridge/core/trunk/pom.xml Thu Jan 8 15:46:03 2009
@@ -1,10 +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 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 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.apache.myfaces.portlet-bridge</groupId>
<artifactId>portlet-bridge</artifactId>
<packaging>pom</packaging>
- <name>MyFaces Portlet Bridge 1.0</name>
+ <name>MyFaces Portlet Bridge</name>
<version>1.0.0-SNAPSHOT</version>
<inceptionYear>2007</inceptionYear>
<description>
@@ -24,8 +43,9 @@
<properties>
<specName>Portlet 1.0 Bridge for JavaServer Faces 1.2</specName>
<specVersion>1.0</specVersion>
- <projectSeries>1.0.x</projectSeries>
+ <projectSeries>1.x</projectSeries>
<jsf.version>1.2_03</jsf.version>
+ <portlet.version>1.0</portlet.version>
</properties>
<!-- issueManagement is in parent -->
@@ -47,18 +67,8 @@
</site>
</distributionManagement>
- <repositories>
- <repository>
- <id>apache.snapshots</id>
- <name>Apache Snapshot Repository</name>
- <url>http://people.apache.org/repo/m2-snapshot-repository</url>
- </repository>
- </repositories>
-
<modules>
<module>api</module>
- <module>impl</module>
- <module>examples</module>
</modules>
<!-- Versions and scope of dependencies -->
@@ -68,7 +78,7 @@
<dependency>
<groupId>portlet-api</groupId>
<artifactId>portlet-api</artifactId>
- <version>1.0</version>
+ <version>${portlet.version}</version>
<scope>provided</scope>
</dependency>
@@ -165,12 +175,12 @@
</plugins>
</build>
- <reporting>
+ <!--reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.2</version>
+ <version>2.5</version>
<configuration>
<aggregate>false</aggregate>
<linksource>true</linksource>
@@ -187,9 +197,43 @@
</configuration>
</plugin>
</plugins>
- </reporting>
+ </reporting-->
<profiles>
+ <profile>
+ <!--This is applied when NOT generating javadocs for the website -->
+ <id>normalBuild</id>
+ <activation>
+ <property>
+ <name>!siteJavadoc</name>
+ </property>
+ </activation>
+
+ <modules>
+ <module>impl</module>
+ <module>examples</module>
+ </modules>
+ </profile>
+
+ <!-- This profile is used for the API documentation on the website.
+ It goes according to the latest release rather then the trunk -->
+ <profile>
+ <id>javadoc-latest-release</id>
+ <activation>
+ <property>
+ <name>siteJavadoc</name>
+ </property>
+ </activation>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
<!-- This profile is invoked by -DprepareRelease=true. This allows mvn release:prepare to
run successfully on the assembly projects. -->
<profile>
Modified: myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm?rev=732875&r1=732874&r2=732875&view=diff
==============================================================================
--- myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm (original)
+++ myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm Thu Jan 8 15:46:03 2009
@@ -24,5 +24,4 @@
This is the ${project.name} ${projectSeries} Project. This is the current reference implementation for
"${specName}".
-~~ This should be changed, eventually, to use ${project.version} instead of hardcoding.
- The currently released version is {{{downloads.html} ${project.name} ${project.version}}}.
\ No newline at end of file
+ The currently released version is {{{downloads.html} ${project.name} 1.0.0-beta}}.