sourcehawk:scan

Full name:

com.optum.sourcehawk.maven:sourcehawk-maven-plugin:0.1.0:scan

Description:

Goal which is responsible for performing scan

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Binds by default to the lifecycle phase: validate.

Required Parameters

Name Type Since Description
<configurationFile> File 1.0.0 The configuration file which is used to configure Sourcehawk
Default value is: sourcehawk.yml.
User property is: sourcehawk.configurationFile.
<reportOutputFile> File 1.0.0 The file which the scan report will be output to, defaults to DEFAULT_REPORT_LOCATION
Default value is: ${project.build.directory}/sourcehawk/report.txt.
User property is: sourcehawk.reportOutputFile.

Optional Parameters

Name Type Since Description
<failBuild> boolean 1.0.0 Whether or not a failed scan should fail the build
Default value is: true.
User property is: sourcehawk.failBuild.
<skip> boolean 1.0.0 Whether or not to skip execution
Default value is: false.
User property is: sourcehawk.skip.
<skipScan> boolean 1.0.0 Whether or not to skip execution
Default value is: false.
User property is: sourcehawk.skipScan.

Parameter Details

<configurationFile>

The configuration file which is used to configure Sourcehawk
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: sourcehawk.configurationFile
  • Default: sourcehawk.yml

<failBuild>

Whether or not a failed scan should fail the build
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: sourcehawk.failBuild
  • Default: true

<reportOutputFile>

The file which the scan report will be output to, defaults to DEFAULT_REPORT_LOCATION
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: sourcehawk.reportOutputFile
  • Default: ${project.build.directory}/sourcehawk/report.txt

<skip>

Whether or not to skip execution
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: sourcehawk.skip
  • Default: false

<skipScan>

Whether or not to skip execution
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: sourcehawk.skipScan
  • Default: false