KFS uses Maven for packaging and unit testing.

Properties

Configuration properties have defaulted values which are included in the KFS war and may be overridden at runtime. There are skeleton config files located in kfs/src/main/config to aid in overriding the most common properties. To override:

  1. Copy the appropriate skel-config.properties file from kfs/src/main/config to a location external to the project (such as your home directory)
  2. Set any values you need to override and comment out or remove the other properties. 
  3. Pass the location of your custom properties files to maven or tomcat on the command line via the following property:

-Dadditional.kfs.config.locations property. 

For ease of future upgrades, you should avoid modifying any of the delivered files under the kfs directory. 

Maven Command Overview

To create a deployable KFS war, you can use the mvn package command. To execute the KFS unit tests, you can use the mvn test command.  See the setup instructions and Maven Introduction to the Build Lifecycle documentation for more information.

 

Ant TargetDescriptionMaven Command
cleanRemove all build outputclean
clean-allDelete all generated/extracted files within the project.clean
debug-devStarts up the included Tomcat server with KFS using Rice in bundled mode.tomcat7:run (startup bundled app in tomcat instance)
debug-dev2Starts up the included Tomcat server with KFS using Rice in embedded (Rice standalone) mode.N/A
distBuilds the KFS war file for the current build.environmentpackage
dist-localPrepare local configuration files and tokenized resources and deploy tomcat context file on development workstationN/A
echo-propertiesPrint all build properties that have been setN/A
helpDescribe public targetsN/A
refresh-dbRefreshes the KFS and Rice database schema(s) for the current build environmentN/A
refresh-kfs-dbRefreshes the KFS components of the database for the current build environmentN/A
refresh-rice-dbRefreshes the Rice component of the database for the current build environmentN/A
reportretrieve dependencies with ivyN/A
resolveresolve dependencies with ivyN/A
run-devStarts up the included Tomcat server with KFS using Rice in bundled mode.see debug-dev
run-dev2Starts up the included Tomcat server with KFS using Rice in embedded (Rice standalone) mode.NA
run-liquibase-dirRuns the directory of liquibase files pointed to by the 'dir.name' property into the main datasource. Files will be run in alphanumeric order.N/A
run-liquibase-fileRuns the liquibase file pointed to by the 'file.name' property into the main datasource.N/A
test-localRun all unit tests and format resultstest