Documentation

How can I get started?

Please refer to the `How can I build jHawk?' section below. Set up jHawk into e.g. the `/usr/local/bin/jhawk' directory. Note the `conf' directory at the same level of the jHawk JAR file. jHawk comes with a sample XML configuration file in the `conf' directory. Edit this file before proceeding. When you are done, jHawk will be ready to execute batch tasks, e.g. to trigger Apache Continuum-based builds on SCM commits. Please refer to the `How can I trigger Apache Continuum-based builds on SCM commits?' section below.

How can I build jHawk?

You need to have Apache Maven installed. Change directory where the jHawk `pom.xml' file is, then invoke Maven by using the "mvn assembly:assembly" command. The `jhawk.jar' file will be placed in the `target' directory. Make sure to copy the `conf' directory in the same directory where the `jhawk.jar' file will be on your server.

How can I trigger Apache Continuum-based builds on SCM commits?

Without parameters, jHawk will build projects specified in the config file. The `--version' parameter shows the version, the `--daily-report' parameter prints out a daily build report.

The example below is assuming that you are using SVN, and you have (e.g.) a PHP-based `hooks/post-commit' file already in place on your SVN server repo. Please refer to your SCM documentation on post-commit hooks setup.

#!/usr/bin/php
// [... other commands ...]
// Triggering a build on the Apache Continuum server
$cmd = 'cd /usr/local/bin/jhawk ; /usr/bin/java -cp jhawk.jar jhawk.JHawk';
$cmd_output = shell_exec($cmd);
// [... other commands ...]