Fork me on GitHub

flatten:resolve

Full name:

com.carrotgarden.maven:flatten-maven-plugin:1.7.20200503170847:resolve

Description:

Resolve dependencies of current project.
Used internally by goal="flatten".
Injects resolution results into plugin context for use by other Mojo.
Actually invokes goal="dependency:resolve" and overrides parameter defaults: excludeTransitive, includeScope, silent, sort, outputFile.
See maven-dependency-plugin

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: prepare-package.

Optional Parameters

Name Type Since Description
<appendOutput> boolean 2.2 Whether to append outputs into the output file or overwrite it.
Default value is: false.
User property is: appendOutput.
<classifier> String 2.0 Specify classifier to look for. Example: sources
User property is: classifier.
<excludeArtifactIds> String 2.0 Comma separated list of Artifact names to exclude.
User property is: excludeArtifactIds.
<excludeClassifiers> String 2.0 Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeClassifiers.
<excludeGroupIds> String 2.0 Comma separated list of GroupId Names to exclude.
User property is: excludeGroupIds.
<excludeReactor> boolean 2.7 Don't resolve plugins that are in the current reactor. Only works for plugins at the moment.
Default value is: true.
User property is: excludeReactor.
<excludeScope> String 2.0 Scope to exclude. An Empty string indicates no scopes (default).
User property is: excludeScope.
<excludeTransitive> boolean - If we should exclude transitive dependencies. Override goal="dependency:resolve"/excludeTransitive. Default is "true", different from goal="dependency:resolve".
Default value is: true.
User property is: flatten.excludeTransitive.
<excludeTypes> String 2.0 Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeTypes.
<ignorePermissions> boolean - not used in this goal
<includeArtifactIds> String 2.0 Comma separated list of Artifact names to include. Empty String indicates include everything (default).
User property is: includeArtifactIds.
<includeClassifiers> String 2.0 Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
User property is: includeClassifiers.
<includeGroupIds> String 2.0 Comma separated list of GroupIds to include. Empty String indicates include everything (default).
User property is: includeGroupIds.
<includeParents> boolean 2.8 Include parent poms in the dependency resolution list.
Default value is: false.
User property is: includeParents.
<includeScope> String - Scope to include. Override goal="dependency:resolve"/includeScope. Default is "compile", different from goal="dependency:resolve".
Default value is: compile.
User property is: flatten.includeScope.
<includeTypes> String 2.0 Comma Separated list of Types to include. Empty String indicates include everything (default).
User property is: includeTypes.
<markersDirectory> File 2.0 Directory to store flag files
Default value is: ${project.build.directory}/dependency-maven-plugin-markers.
User property is: markersDirectory.
<outputAbsoluteArtifactFilename> boolean 2.0 Output absolute filename for resolved artifacts
Default value is: false.
User property is: outputAbsoluteArtifactFilename.
<outputFile> File - If specified, this parameter will cause the dependencies to be written to the path specified, instead of writing to the console. Override goal="dependency:resolve"/outputFile. Default is "resolve.log", different from goal="dependency:resolve".
Default value is: ${project.build.directory}/flatten/resolve.log.
User property is: flatten.outputFile.
<outputScope> boolean 2.0-alpha-2 If we should display the scope when resolving
Default value is: true.
User property is: mdep.outputScope.
<overWriteIfNewer> boolean 2.0 Overwrite artifacts that don't exist or are older than the source.
Default value is: true.
User property is: overWriteIfNewer.
<overWriteReleases> boolean 1.0 Overwrite release artifacts
Default value is: false.
User property is: overWriteReleases.
<overWriteSnapshots> boolean 1.0 Overwrite snapshot artifacts
Default value is: false.
User property is: overWriteSnapshots.
<prependGroupId> boolean 2.2 Prepend the groupId during copy.
Default value is: false.
User property is: mdep.prependGroupId.
<silent> boolean - If the plugin should be silent. Override goal="dependency:resolve"/silent. Default is "true", different from goal="dependency:resolve".
Default value is: true.
User property is: flatten.silent.
<skip> boolean 2.7 Skip plugin execution completely.
Default value is: false.
User property is: mdep.skip.
<sort> boolean - Sort the output list of resolved artifacts alphabetically. Override goal="dependency:resolve"/sort. Default is "true", different from goal="dependency:resolve".
Default value is: true.
User property is: flatten.sort.
<type> String 2.0 Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
User property is: type.
<useJvmChmod> boolean - not used in this goal

Parameter Details

<appendOutput>

Whether to append outputs into the output file or overwrite it.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: appendOutput
  • Default: false

<classifier>

Specify classifier to look for. Example: sources
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: classifier

<excludeArtifactIds>

Comma separated list of Artifact names to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeArtifactIds

<excludeClassifiers>

Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeClassifiers

<excludeGroupIds>

Comma separated list of GroupId Names to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeGroupIds

<excludeReactor>

Don't resolve plugins that are in the current reactor. Only works for plugins at the moment.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: excludeReactor
  • Default: true

<excludeScope>

Scope to exclude. An Empty string indicates no scopes (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeScope

<excludeTransitive>

If we should exclude transitive dependencies. Override goal="dependency:resolve"/excludeTransitive. Default is "true", different from goal="dependency:resolve".
  • Type: boolean
  • Required: No
  • User Property: flatten.excludeTransitive
  • Default: true

<excludeTypes>

Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeTypes

<ignorePermissions>

not used in this goal
  • Type: boolean
  • Required: No

<includeArtifactIds>

Comma separated list of Artifact names to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeArtifactIds

<includeClassifiers>

Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeClassifiers

<includeGroupIds>

Comma separated list of GroupIds to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeGroupIds

<includeParents>

Include parent poms in the dependency resolution list.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • User Property: includeParents
  • Default: false

<includeScope>

Scope to include. Override goal="dependency:resolve"/includeScope. Default is "compile", different from goal="dependency:resolve".
  • Type: java.lang.String
  • Required: No
  • User Property: flatten.includeScope
  • Default: compile

<includeTypes>

Comma Separated list of Types to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeTypes

<markersDirectory>

Directory to store flag files
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • User Property: markersDirectory
  • Default: ${project.build.directory}/dependency-maven-plugin-markers

<outputAbsoluteArtifactFilename>

Output absolute filename for resolved artifacts
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: outputAbsoluteArtifactFilename
  • Default: false

<outputFile>

If specified, this parameter will cause the dependencies to be written to the path specified, instead of writing to the console. Override goal="dependency:resolve"/outputFile. Default is "resolve.log", different from goal="dependency:resolve".
  • Type: java.io.File
  • Required: No
  • User Property: flatten.outputFile
  • Default: ${project.build.directory}/flatten/resolve.log

<outputScope>

If we should display the scope when resolving
  • Type: boolean
  • Since: 2.0-alpha-2
  • Required: No
  • User Property: mdep.outputScope
  • Default: true

<overWriteIfNewer>

Overwrite artifacts that don't exist or are older than the source.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: overWriteIfNewer
  • Default: true

<overWriteReleases>

Overwrite release artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: overWriteReleases
  • Default: false

<overWriteSnapshots>

Overwrite snapshot artifacts
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: overWriteSnapshots
  • Default: false

<prependGroupId>

Prepend the groupId during copy.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: mdep.prependGroupId
  • Default: false

<silent>

If the plugin should be silent. Override goal="dependency:resolve"/silent. Default is "true", different from goal="dependency:resolve".
  • Type: boolean
  • Required: No
  • User Property: flatten.silent
  • Default: true

<skip>

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

<sort>

Sort the output list of resolved artifacts alphabetically. Override goal="dependency:resolve"/sort. Default is "true", different from goal="dependency:resolve".
  • Type: boolean
  • Required: No
  • User Property: flatten.sort
  • Default: true

<type>

Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: type

<useJvmChmod>

not used in this goal
  • Type: boolean
  • Required: No