7.4 Adding CheckStyle Report

Added by Steve Luo, last edited by Lubos Pochman on Sep 07, 2008  (view change)
QuickBuild 2.0 Documentation

To add CheckStyle report, you only need two steps:

  1. Generate CheckStyle XML report from Ant or Maven or any other build tool.
  2. Publish CheckStyle report in the configuration.

Generate CheckStyle Report

QuickBuild will NOT generate CheckStyle report automatically, so first make sure the CheckStyle report is produced by ANT or by any other build tool. The following example shows how to generate CheckStyle XML report by Ant JUnit task:

CheckStyle target in build.xml
<target name="checkstyle" description="Check coding style">
        <taskdef resource="checkstyletask.properties">
            <classpath refid="path.lib"/>
        </taskdef>
	<checkstyle config="checkstyle_checks.xml">
            <fileset dir="${src.dir}">
		<include name="**/*.java"/>
	    </fileset>
	    <formatter type="xml"/> <!-- DO use xml formatter -->
	</checkstyle>
    </target>

After adding the target above, generate the XML report for your source code, and you can tell QuickBuild to publish the results.

Publish CheckStyle Report

Just like all other build reports, to add CheckStyle report, just follow [adding a publish step] in a configuration. When you add publish CheckStyle Report step, the following screen will be displayed:

Unable to render embedded object: File (report_publish_step.png) not found.

In source report files field, QuickBuild uses Ant style file patterns to collect the reports, and the directory you specified is relative to the [workspace] directory.

QuickBuild will analyze the CheckStyle report and it will generate the Overview/Details after each build, and it also will generate the statistics for the reports.

Labels

 
(None)