clean:clean

Full name:

org.apache.maven.plugins:maven-clean-plugin:2.3:clean

Description:

Goal which cleans the build.

This attempts to clean a project's working directory of the files that were generated at build-time. By default, it discovers and deletes the directories configured in project.build.directory, project.build.outputDirectory, project.build.testOutputDirectory, and project.reporting.outputDirectory.

Files outside the default may also be included in the deletion by configuring the filesets tag.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
excludeDefaultDirectories boolean 2.3 Disables the deletion of the default output directories configured for a project. If set to true, only the files/directories selected via the parameter filesets will be deleted.
Default value is: false.
failOnError boolean 2.2 Indicates whether the build will continue even if there are clean errors.
Default value is: true.
filesets List 2.1 The list of file sets to delete, in addition to the default directories.
followSymLinks boolean 2.1 Sets whether the plugin should follow symbolic links to delete files.
Default value is: false.
skip boolean 2.2 Disables the plugin execution.
Default value is: false.
verbose Boolean 2.1 Sets whether the plugin runs in verbose mode. As of plugin version 2.3, the default value is derived from Maven's global debug flag (compare command line switch -X).

Parameter Details

excludeDefaultDirectories:

Disables the deletion of the default output directories configured for a project. If set to true, only the files/directories selected via the parameter filesets will be deleted.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${clean.excludeDefaultDirectories}
  • Default: false

failOnError:

Indicates whether the build will continue even if there are clean errors.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${maven.clean.failOnError}
  • Default: true

filesets:

The list of file sets to delete, in addition to the default directories.
  • Type: java.util.List
  • Since: 2.1
  • Required: No

followSymLinks:

Sets whether the plugin should follow symbolic links to delete files.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${clean.followSymLinks}
  • Default: false

skip:

Disables the plugin execution.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${clean.skip}
  • Default: false

verbose:

Sets whether the plugin runs in verbose mode. As of plugin version 2.3, the default value is derived from Maven's global debug flag (compare command line switch -X).
  • Type: java.lang.Boolean
  • Since: 2.1
  • Required: No
  • Expression: ${clean.verbose}