Build

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:

Copy the appropriate skel-config.properties file from kfs/src/main/config to a location external to the project (such as your home directory)
Set any values you need to override and comment out or remove the other properties.
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 Target	Description	Maven Command
clean	Remove all build output	clean
clean-all	Delete all generated/extracted files within the project.	clean
debug-dev	Starts up the included Tomcat server with KFS using Rice in bundled mode.	N/A
debug-dev2	Starts up the included Tomcat server with KFS using Rice in embedded (Rice standalone) mode.	N/A
dist	Builds the KFS war file for the current build.environment	package
dist-local	Prepare local configuration files and tokenized resources and deploy tomcat context file on development workstation	N/A
echo-properties	Print all build properties that have been set	N/A
help	Describe public targets	N/A
refresh-db	Refreshes the KFS and Rice database schema(s) for the current build environment	N/A
refresh-kfs-db	Refreshes the KFS components of the database for the current build environment	N/A
refresh-rice-db	Refreshes the Rice component of the database for the current build environment	N/A
report	retrieve dependencies with ivy	N/A
resolve	resolve dependencies with ivy	N/A
run-dev	Starts up the included Tomcat server with KFS using Rice in bundled mode.	see debug-dev
run-dev2	Starts up the included Tomcat server with KFS using Rice in embedded (Rice standalone) mode.	NA
run-liquibase-dir	Runs 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-file	Runs the liquibase file pointed to by the 'file.name' property into the main datasource.	N/A
test-local	Run all unit tests and format results	test

Kuali documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.5 License.

Kuali software is licensed for use pursuant to the Affero General Public License, version 3.

Copyright © 2014 Kuali, Inc. All rights reserved.

Portions of Kuali are copyrighted by other parties as described in the Acknowledgments screen.

Kuali ® is a registered trademark of the Trustees of Indiana University.