These instructions will walk through how to build the RichFaces 4 project.
These instructions are also closely related to some other useful wiki pages:
Build Project Modules
- Install Maven 3.0.3+ & JDK 1.6+
- Follow these instructions for configuring maven.
- setup system variable MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
Building Separated Modules
Select a module you want to build across RichFaces GitHub repositories: https://github.com/richfaces4
- Clone module locally (subsiitute the module name for [MODULE] in the following commands):
git clone git://github.com/richfaces4/[MODULE].git
- Integration Managers:
git clone email@example.com:richfaces4/[MODULE].git
- run maven installation from the [MODULE] directory:
All resources and dependencies needed for build separated modules will be fetched from JBoss Maven repository (in case of problems, check your your settings.xml).
Building Whole Core Project at Once
- Clone a RichFaces Build Root project from GitHub
- If you would like to develop at your own and possibly provide patches back to RichFaces master, we suggest to use your own public fork of RichFaces repository and making Pull Requests against RichFaces master branch.
git clone git://github.com/richfaces4/build.git
- Integration Managers:
git clone firstname.lastname@example.org:richfaces4/build.git
- checkout remaining modules anonymously
bash build/scripts/richgit.sh -t git
- or fork and checkout your own modules (you will be prompted for your github password
bash build/scripts/richgit.sh -u <username> -f
- OR checkout all Framework Modules (cdk, core, components, ...) manually in top-level directory (../build) - build process counts with flat directory structure
- Follow this guide to configure the Jboss Maven repository if you havent done so already.
- Execute Maven to trigger the build (first, cd into the build project folder)
mvn clean install -P build
- Use Maven profile "release" to build full distribution and javadocs
mvn clean install -P build,release
- Thats it! The project should build, and pull down anything that is needed using maven
- You can also import the project into many IDE's
- Most notably using the maven integration with JBoss Tools
- For building Framework supporting modules, download repositories for RichFaces Build Resources (parent, checkstyle, shade-transformers, ...) and use Maven profile "bootstrap" [LINK]
mvn clean install -P bootstrap
Below is a listing of build options that apply to the core project build for RichFaces 4.0. See RichFaces 4.0 Build Directory Structure for more on the RichFaces 4.0 directory structure.
This is the standard maven command that will cause all modules to skip their unit and functional tests. This is sometimes useful for rapid builds. This can not be skipped prior to checking in source code.
This command will cause all checkstyle scans to be skipped. This can be useful for in process development builds, and or to speed up a build. This can not be skipped prior to to checking in source code.
With this option set the builds will not produce source jars.
With this option set the builds will skip the JDK version, Maven version, and no SNAPSHOT plugin checks.
Setting JSF Implementation
-Djsf_profile=[ jboss | myfaces ]
- jsf_ri - *default* (do not define jsf_profile) or use empty -Djsf_profile='')
- Supported release of JSF RI ( Mojarra )
- Supported release of JSF RI distributed in JBoss AS 7
- Supported release of MyFaces
clover2:aggregate clover2:clover -Pclover
Documentation & QE Testing Applications
The doc team and QE groups both maintain their own build instructions. These can be very useful to explore a new corner of the RichFaces project.