clean:clean

Full name:

org.apache.maven.plugins:maven-clean-plugin:2.6: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 project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • 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.
User property is: clean.excludeDefaultDirectories.
failOnError boolean 2.2 Indicates whether the build will continue even if there are clean errors.
Default value is: true.
User property is: maven.clean.failOnError.
filesets Fileset[] 2.1 The list of file sets to delete, in addition to the default directories. For example:
<filesets>
  <fileset>
    <directory>src/main/generated</directory>
    <followSymlinks>false</followSymlinks>
    <useDefaultExcludes>true</useDefaultExcludes>
    <includes>
      <include>*.java</include>
    </includes>
    <excludes>
      <exclude>Template*</exclude>
    </excludes>
  </fileset>
</filesets>

followSymLinks boolean 2.1 Sets whether the plugin should follow symbolic links while deleting files from the default output directories of the project. Not following symlinks requires more IO operations and heap memory, regardless whether symlinks are actually present. So projects with a huge output directory that knowingly does not contain symlinks can improve performance by setting this parameter to true.
Default value is: false.
User property is: clean.followSymLinks.
retryOnError boolean 2.4.2 Indicates whether the plugin should undertake additional attempts (after a short delay) to delete a file if the first attempt failed. This is meant to help deleting files that are temporarily locked by third-party tools like virus scanners or search indexing.
Default value is: true.
User property is: maven.clean.retryOnError.
skip boolean 2.2 Disables the plugin execution.
Default value is: false.
User property is: clean.skip.
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).
User property is: clean.verbose.

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
  • User Property: clean.excludeDefaultDirectories
  • Default: false

failOnError:

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

filesets:

The list of file sets to delete, in addition to the default directories. For example:
<filesets>
  <fileset>
    <directory>src/main/generated</directory>
    <followSymlinks>false</followSymlinks>
    <useDefaultExcludes>true</useDefaultExcludes>
    <includes>
      <include>*.java</include>
    </includes>
    <excludes>
      <exclude>Template*</exclude>
    </excludes>
  </fileset>
</filesets>
  • Type: org.apache.maven.plugin.clean.Fileset[]
  • Since: 2.1
  • Required: No

followSymLinks:

Sets whether the plugin should follow symbolic links while deleting files from the default output directories of the project. Not following symlinks requires more IO operations and heap memory, regardless whether symlinks are actually present. So projects with a huge output directory that knowingly does not contain symlinks can improve performance by setting this parameter to true.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: clean.followSymLinks
  • Default: false

retryOnError:

Indicates whether the plugin should undertake additional attempts (after a short delay) to delete a file if the first attempt failed. This is meant to help deleting files that are temporarily locked by third-party tools like virus scanners or search indexing.
  • Type: boolean
  • Since: 2.4.2
  • Required: No
  • User Property: maven.clean.retryOnError
  • Default: true

skip:

Disables the plugin execution.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: 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
  • User Property: clean.verbose