Built by Maven

dependency:render-dependencies

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.9.0:render-dependencies

Description:

This goal renders dependencies based on a velocity template.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 3.9.0.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
<template> String 3.9.0 Velocity template to use to render the output file. It can be inline or a file path.
User Property: mdep.template

Optional Parameters

Name Type Since Description
<classifier> String 3.9.0 If not null or empty it will attach the artifact with this classifier.
Default: template
User Property: mdep.classifier
<excludeArtifactIds> String 2.0 Comma-separated list of artifact IDs to exclude.
User Property: excludeArtifactIds
<excludeClassifiers> String 2.0 Comma-separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User Property: excludeClassifiers
<excludeGroupIds> String 2.0 Comma-separated list of group IDs to exclude.
User Property: excludeGroupIds
<excludeScope> String 2.0 Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default). Unlike the other exclusion parameters, this property does not support a comma-delimited list of scope exclusions. Just one scope may be excluded at a time.
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime exclude scope excludes runtime and compile dependencies,
  • compile exclude scope excludes compile, provided, and system dependencies,
  • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
  • provided exclude scope just excludes provided dependencies,
  • system exclude scope just excludes system dependencies.

User Property: excludeScope
<excludeTransitive> boolean 2.0 If we should exclude transitive dependencies.
Default: false
User Property: excludeTransitive
<excludeTypes> String 2.0 Comma-separated list of Types to exclude. Empty String indicates don't exclude anything (default).
User Property: excludeTypes
<extension> String 3.9.0 Extension to use for the attached file if classifier is not null/empty.
Default: txt
User Property: mdep.extension
<includeArtifactIds> String 2.0 Comma-separated list of artifact IDs to include. Empty String indicates include everything (default).
User Property: includeArtifactIds
<includeClassifiers> String 2.0 Comma-separated list of Classifiers to include. Empty string indicates include everything (default).
User Property: includeClassifiers
<includeGroupIds> String 2.0 Comma-separated list of group IDs to include. Empty string indicates include everything (default).
User Property: includeGroupIds
<includeScope> String 2.0 Scope threshold to include. An empty string indicates include all dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime include scope gives runtime and compile dependencies,
  • compile include scope gives compile, provided, and system dependencies,
  • test include scope gives all dependencies (equivalent to default),
  • provided include scope just gives provided dependencies,
  • system include scope just gives system dependencies.

User Property: includeScope
<includeTypes> String 2.0 Comma-separated list of Types to include. Empty String indicates include everything (default).
User Property: includeTypes
<markersDirectory> File 2.0 Directory to store flag files.
Default: ${project.build.directory}/dependency-maven-plugin-markers
User Property: markersDirectory
<outputEncoding> String 3.9.0 Encoding to write the rendered template.
Default: ${project.reporting.outputEncoding}
User Property: outputEncoding
<outputFile> File 3.9.0 The file to write the rendered template string. If undefined, it just prints the classpath as [INFO].
User Property: mdep.outputFile
<overWriteIfNewer> boolean 2.0 Overwrite artifacts that don't exist or are older than the source.
Default: true
User Property: overWriteIfNewer
<overWriteReleases> boolean 1.0 Overwrite release artifacts.
Default: false
User Property: overWriteReleases
<overWriteSnapshots> boolean 1.0 Overwrite snapshot artifacts.
Default: false
User Property: overWriteSnapshots
<prependGroupId> boolean 2.2 Prepend the group ID during copy.
Default: false
User Property: mdep.prependGroupId
<silent> boolean 2.0
Deprecated.
to be removed in 4.0; use -q command line option instead

If the plugin should be silent.
Default: false
User Property: silent
<skip> boolean 2.7 Skip plugin execution completely.
Default: false
User Property: mdep.skip
<skipDuringIncrementalBuild> boolean 3.4.0 Skip plugin execution only during incremental builds (e.g. triggered from M2E).
See also: org.apache.maven.plugins.dependency.AbstractDependencyMojo.skip
Default: false
<type> String 2.0 Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war.
User Property: type

Parameter Details

<classifier>

If not null or empty it will attach the artifact with this classifier.
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: No
  • User Property: mdep.classifier
  • Default: template

<excludeArtifactIds>

Comma-separated list of artifact IDs 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 group IDs to exclude.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeGroupIds

<excludeScope>

Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default). Unlike the other exclusion parameters, this property does not support a comma-delimited list of scope exclusions. Just one scope may be excluded at a time.
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime exclude scope excludes runtime and compile dependencies,
  • compile exclude scope excludes compile, provided, and system dependencies,
  • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
  • provided exclude scope just excludes provided dependencies,
  • system exclude scope just excludes system dependencies.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: excludeScope

<excludeTransitive>

If we should exclude transitive dependencies.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: excludeTransitive
  • Default: false

<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

<extension>

Extension to use for the attached file if classifier is not null/empty.
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: No
  • User Property: mdep.extension
  • Default: txt

<includeArtifactIds>

Comma-separated list of artifact IDs 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 group IDs to include. Empty string indicates include everything (default).
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeGroupIds

<includeScope>

Scope threshold to include. An empty string indicates include all dependencies (default).
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:
  • runtime include scope gives runtime and compile dependencies,
  • compile include scope gives compile, provided, and system dependencies,
  • test include scope gives all dependencies (equivalent to default),
  • provided include scope just gives provided dependencies,
  • system include scope just gives system dependencies.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: includeScope

<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

<outputEncoding>

Encoding to write the rendered template.
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

<outputFile>

The file to write the rendered template string. If undefined, it just prints the classpath as [INFO].
  • Type: java.io.File
  • Since: 3.9.0
  • Required: No
  • User Property: mdep.outputFile

<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 group ID during copy.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: mdep.prependGroupId
  • Default: false

<silent>

Deprecated.
to be removed in 4.0; use -q command line option instead

If the plugin should be silent.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: silent
  • Default: false

<skip>

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

<skipDuringIncrementalBuild>

Skip plugin execution only during incremental builds (e.g. triggered from M2E).
See also: org.apache.maven.plugins.dependency.AbstractDependencyMojo.skip
  • Type: boolean
  • Since: 3.4.0
  • Required: No
  • Default: false

<template>

Velocity template to use to render the output file. It can be inline or a file path.
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: Yes
  • User Property: mdep.template

<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