dependency:purge-local-repository

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.0.0:purge-local-repository

Description:

When run on a project, remove the project dependencies from the local repository, and optionally re-resolve them. Outside of a project, remove the manually given dependencies.

Attributes:

  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
actTransitively boolean 2.0 Whether this mojo should act on all transitive dependencies. Default value is true.
Default value is: true.
User property is: actTransitively.
exclude String 2.0 Comma-separated list of groupId:artifactId entries, which should be used to exclude artifacts from deletion/refresh. This is a command-line alternative to the excludes parameter, since List parameters are not currently compatible with CLI specification.
User property is: exclude.
excludes List 2.0 The list of dependencies in the form of groupId:artifactId which should NOT be deleted/refreshed.
include String 2.6 Comma-separated list of groupId:artifactId entries, which should be used to include artifacts for deletion/refresh. This is a command-line alternative to the includes parameter, since List parameters are not currently compatible with CLI specification.
User property is: include.
includes List 2.6 The list of dependencies in the form of groupId:artifactId which should BE deleted/refreshed.
manualInclude String 2.6 Comma-separated list of groupId:artifactId entries, which should be used to manually include artifacts for deletion. This is a command-line alternative to the manualIncludes parameter, since List parameters are not currently compatible with CLI specification.
User property is: manualInclude.
manualIncludes List 2.6 The list of dependencies in the form of groupId:artifactId which should BE deleted/purged from the local repository. Note that using this parameter will deactivate the normal process for purging the current project dependency tree. If this parameter is used, only the included artifacts will be purged. The manualIncludes parameter should not be used in combination with the includes/excludes parameters.
reResolve boolean 2.0 Whether to re-resolve the artifacts once they have been deleted from the local repository. If you are running this mojo from the command-line, you may want to disable this. By default, artifacts will be re-resolved.
Default value is: true.
User property is: reResolve.
resolutionFuzziness String 2.0 Determines how liberally the plugin will delete an artifact from the local repository. Values are:
  • file - Eliminate only the artifact's file.
  • version (default) - Eliminate all files associated with the version of the artifact.
  • artifactId - Eliminate all files associated with the artifact's artifactId.
  • groupId - Eliminate all files associated with the artifact's groupId.

Default value is: version.
User property is: resolutionFuzziness.
skip boolean 2.7 Skip plugin execution completely.
Default value is: false.
User property is: skip.
snapshotsOnly boolean 2.4 Whether to purge only snapshot artifacts.
Default value is: false.
User property is: snapshotsOnly.
verbose boolean 2.0 Whether this plugin should output verbose messages. Default is false.
Default value is: false.
User property is: verbose.

Parameter Details

actTransitively:

Whether this mojo should act on all transitive dependencies. Default value is true.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: actTransitively
  • Default: true

exclude:

Comma-separated list of groupId:artifactId entries, which should be used to exclude artifacts from deletion/refresh. This is a command-line alternative to the excludes parameter, since List parameters are not currently compatible with CLI specification.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: exclude

excludes:

The list of dependencies in the form of groupId:artifactId which should NOT be deleted/refreshed.
  • Type: java.util.List
  • Since: 2.0
  • Required: No

include:

Comma-separated list of groupId:artifactId entries, which should be used to include artifacts for deletion/refresh. This is a command-line alternative to the includes parameter, since List parameters are not currently compatible with CLI specification.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: include

includes:

The list of dependencies in the form of groupId:artifactId which should BE deleted/refreshed.
  • Type: java.util.List
  • Since: 2.6
  • Required: No

manualInclude:

Comma-separated list of groupId:artifactId entries, which should be used to manually include artifacts for deletion. This is a command-line alternative to the manualIncludes parameter, since List parameters are not currently compatible with CLI specification.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: manualInclude

manualIncludes:

The list of dependencies in the form of groupId:artifactId which should BE deleted/purged from the local repository. Note that using this parameter will deactivate the normal process for purging the current project dependency tree. If this parameter is used, only the included artifacts will be purged. The manualIncludes parameter should not be used in combination with the includes/excludes parameters.
  • Type: java.util.List
  • Since: 2.6
  • Required: No

reResolve:

Whether to re-resolve the artifacts once they have been deleted from the local repository. If you are running this mojo from the command-line, you may want to disable this. By default, artifacts will be re-resolved.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: reResolve
  • Default: true

resolutionFuzziness:

Determines how liberally the plugin will delete an artifact from the local repository. Values are:
  • file - Eliminate only the artifact's file.
  • version (default) - Eliminate all files associated with the version of the artifact.
  • artifactId - Eliminate all files associated with the artifact's artifactId.
  • groupId - Eliminate all files associated with the artifact's groupId.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: resolutionFuzziness
  • Default: version

skip:

Skip plugin execution completely.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: skip
  • Default: false

snapshotsOnly:

Whether to purge only snapshot artifacts.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • User Property: snapshotsOnly
  • Default: false

verbose:

Whether this plugin should output verbose messages. Default is false.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: verbose
  • Default: false