bom:bom

Full name:

org.kuali.maven.plugins:bom-maven-plugin:1.0.0-SNAPSHOT:bom

Description:

Goal to detect and strip BOMs from files.

Attributes:

  • Binds by default to the lifecycle phase: process-sources.

Optional Parameters

Name Type Since Description
basedir File - Location of a single file to strip the BOM from.
excludes String[] - Exclusion patterns. By default nothing is excluded
failBuild boolean - Set to true if you want the build to fail if a BOM is found.
Default value is: false.
includes String[] - Inclusion patterns. By default, all files are included
strip boolean - Set to true if you want to remove any BOM's detected by the plugin
Default value is: false.
useDefaultExcludes boolean - Use default excludes
Default value is: true.
workingDir File - Directory where a backup copy of any file having its BOM removed is created
Default value is: ${project.build.directory}/bom.

Parameter Details

basedir:

Location of a single file to strip the BOM from.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.basedir}

excludes:

Exclusion patterns. By default nothing is excluded
  • Type: java.lang.String[]
  • Required: No

failBuild:

Set to true if you want the build to fail if a BOM is found.
  • Type: boolean
  • Required: No
  • Expression: ${bom.failBuild}
  • Default: false

includes:

Inclusion patterns. By default, all files are included
  • Type: java.lang.String[]
  • Required: No

strip:

Set to true if you want to remove any BOM's detected by the plugin
  • Type: boolean
  • Required: No
  • Expression: ${bom.strip}
  • Default: false

useDefaultExcludes:

Use default excludes
  • Type: boolean
  • Required: No
  • Expression: ${bom.useDefaultExcludes}
  • Default: true

workingDir:

Directory where a backup copy of any file having its BOM removed is created
  • Type: java.io.File
  • Required: No
  • Expression: ${bom.workingDir}
  • Default: ${project.build.directory}/bom