3.0.0+
The <code><project></code> element is the root of the
descriptor.
The following table lists all of the possible child elements.
3.0.0+
The <code><project></code> element is the root of the
descriptor.
The following table lists all of the possible child elements.
4.0.0
The location of the parent project, if one exists. Values from the
parent project will be the default for this project if they are
left unspecified. The location is given as a group ID, artifact ID and
version.
4.0.0
Declares to which version of
project descriptor this POM conforms.
3.0.0+
A universally unique identifier for a project. It is normal to
use a fully-qualified package name to distinguish it from other projects with
a similar name
(eg. <code>org.apache.maven</code>).
3.0.0+
The identifier for this artifact that is unique within the group given by the
group ID.
An artifact is something that is either produced or used by a project.
Examples of artifacts produced by
Maven for a project include: JARs, source and binary distributions, and WARs.
4.0.0
The type of artifact this project produces, for example
<code>jar</code>
<code>war</code>
<code>ear</code>
<code>pom</code>.
Plugins can create their own packaging, and
therefore their own packaging types,
so this list does not contain all possible types.
3.0.0+
The full name of the project.
4.0.0
The current version of the artifact produced by this project.
3.0.0+
A detailed description of the project, used by Maven whenever it needs to
describe the project,
such as on the web site. While this element can be specified as CDATA to
enable
the use of HTML tags within the description, it is discouraged to allow plain
text representation.
If you need to modify the index page of the generated web site, you are able
to specify your own instead
of adjusting this text.
3.0.0+
The URL to the project's homepage.
4.0.0
Describes the prerequisites in the build environment for this project.
4.0.0
The project's issue
management system information.
4.0.0
The project's continuous
integration information.
3.0.0+
The year of the project's inception, specified with 4 digits.
This value is used when generating copyright notices as well as being
informational.
3.0.0+
Contains information about a project's mailing lists.
3.0.0+
Describes the committers of a project.
3.0.0+
Describes the contributors to a project that are not yet committers.
3.0.0+
This element describes all of the licenses for this project.
Each license is described by a <code>license</code> element, which
is then described by additional elements.
Projects should only list the license(s) that applies to the project
and not the licenses that apply to dependencies.
If multiple licenses are listed, it is assumed that the user can select any
of them, not that they
must accept all.
4.0.0
Specification for the SCM used by the project, such as CVS, Subversion, etc.
3.0.0+
This element describes various attributes of the organization to
which the project belongs. These attributes are utilized when
documentation is created (for copyright notices and links).
3.0.0+
Information required to build the
project.
4.0.0
A listing of project-local build profiles which will modify the build
process when activated.
4.0.0
The modules (sometimes called subprojects) to build as a part of this
project.
Each module listed is a relative path to the directory containing the module.
4.0.0
The lists of the remote
repositories for discovering dependencies and
extensions.
4.0.0
The lists of the remote repositories for discovering plugins for builds and
reports.
3.0.0+
This element describes all of the dependencies associated with a
project.
These dependencies are used to construct a classpath for your
project during the build process. They are automatically downloaded from the
repositories defined in this project.
See <a
href="http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">the
dependency mechanism</a> for more information.
4.0.0
<b>Deprecated</b>. Now ignored by Maven.
4.0.0
This element includes the specification of report plugins to use to generate
the reports on the
Maven-generated site. These reports will be run when a user executes <code>mvn
site</code>. All of the
reports will be included in the navigation bar for browsing.
4.0.0
Default dependency information for projects that inherit from
this one. The dependencies in this section are not immediately resolved.
Instead, when a POM derived from this one declares a dependency
described by a matching groupId and artifactId, the version and other values from
this
section are used for that dependency if they were not already specified.
4.0.0
Distribution information for a
project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.
4.0.0
Properties that can be used throughout the POM as a substitution, and are used as
filters in resources
if enabled. The format is
<code><name>value</name></code>.
3.0.0+
Description of a person who has contributed to the project, but who does
not have commit privileges. Usually, these contributions come in the
form of patches submitted.
3.0.0+
The full name of the contributor.
3.0.0+
The email address of the
contributor.
3.0.0+
The URL for the homepage of the
contributor.
3.0.0+
The organization to which the
contributor belongs.
3.0.0+
The URL of the organization.
3.0.0+
The roles the contributor plays in the project. Each role is
described by a <code>role</code> element, the body of which is a
role name. This can also be used to describe the contribution.
3.0.0+
The timezone the contributor is in. This is a number in the range -11 to 12.
3.0.0+
Properties about the contributor, such as an instant messenger handle.
4.0.0
Modifications to the build process which is activated based on environmental parameters
or command line arguments.
4.0.0
The identifier of this build
profile. This used both for command line activation, and identifies
identical profiles to merge with during inheritance.
4.0.0
The conditional logic which will
automatically
trigger the inclusion of this profile.
4.0.0
Information required to build the
project.
4.0.0
The modules (sometimes called subprojects) to build as a part of this
project.
Each module listed is a relative path to the directory containing the module.
4.0.0
The lists of the remote
repositories for discovering dependencies and
extensions.
4.0.0
The lists of the remote repositories for discovering plugins for builds and
reports.
3.0.0+
This element describes all of the dependencies associated with a
project.
These dependencies are used to construct a classpath for your
project during the build process. They are automatically downloaded from the
repositories defined in this project.
See <a
href="http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">the
dependency mechanism</a> for more information.
4.0.0
<b>Deprecated</b>. Now ignored by Maven.
4.0.0
This element includes the specification of report plugins to use to generate
the reports on the
Maven-generated site. These reports will be run when a user executes <code>mvn
site</code>. All of the
reports will be included in the navigation bar for browsing.
4.0.0
Default dependency information for projects that inherit from
this one. The dependencies in this section are not immediately resolved.
Instead, when a POM derived from this one declares a dependency
described by a matching groupId and artifactId, the version and other values from
this
section are used for that dependency if they were not already specified.
4.0.0
Distribution information for a
project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.
4.0.0
Properties that can be used throughout the POM as a substitution, and are used as
filters in resources
if enabled. The format is
<code><name>value</name></code>.
4.0.0
The conditions within the build runtime environment which will trigger
the automatic inclusion of the build profile.
4.0.0
Flag specifying whether this
profile is active by default.
4.0.0
Specifies that this profile will be activated when a matching JDK is detected. For
example, <code>1.4</code>
only activates on JDKs versioned 1.4, while <code>!1.4</code>
matches any JDK that is not version 1.4.
4.0.0
Specifies that this profile will be activated when matching operating system
attributes are detected.
4.0.0
Specifies that this profile will be activated when this system property is
specified.
4.0.0
Specifies that this profile will be activated based on existence of a file.
4.0.0
This is the file specification used to activate the profile. The missing value
will be the location
of a file that needs to exist, and if it doesn't the profile will be
activated. On the other hand exists will test
for the existence of the file and if it is there the profile will be activated.
4.0.0
The name of the file that must be
missing to activate the profile.
4.0.0
The name of the file that must
exist to activate the profile.
4.0.0
This is the property specification used to activate a profile. If the value
field is empty,
then the existence of the named property will activate the profile, otherwise it
does a case-sensitive
match against the property value as well.
4.0.0
The name of the property to be
used to activate a profile.
4.0.0
The value of the property
required to activate a profile.
4.0.0
This is an activator which will detect an operating system's attributes in
order to activate
its profile.
4.0.0
The name of the operating system
to be used to activate the profile. This must be an exact match
of the <code>${os.name}</code> Java property, such as
<code>Windows XP</code>.
4.0.0
The general family of the OS to be used to activate the profile, such as
<code>windows</code> or <code>unix</code>.
4.0.0
The architecture of the operating
system to be used to activate the profile.
4.0.0
The version of the operating
system to be used to activate the profile.
4.0.0
Section for management of default dependency information for use in a group of
POMs.
4.0.0
The dependencies specified here are not used until they
are referenced in a POM within the group. This allows the
specification of a "standard" version for a particular
dependency.
3.0.0+
3.0.0+
The project group that produced the dependency, e.g.
<code>org.apache.maven</code>.
3.0.0+
The unique id for an artifact produced by the project group, e.g.
<code>maven-artifact</code>.
3.0.0+
The version of the dependency, e.g. <code>3.2.1</code>. In Maven
2, this can also be
specified as a range of versions.
4.0.0
The type of dependency. This defaults to <code>jar</code>. While
it usually represents the extension on
the filename of the dependency, that is not always the case. A type can be
mapped to a different
extension and a classifier.
The type often correspongs to the packaging used, though this is also not
always the case.
Some examples are <code>jar</code>, <code>war</code>,
<code>ejb-client</code> and <code>test-jar</code>.
New types can be defined by plugins that set
<code>extensions</code> to <code>true</code>, so
this is not a complete list.
4.0.0
The classifier of the dependency. This allows distinguishing two artifacts
that belong to the same POM but
were built differently, and is appended to the filename after the version. For
example,
<code>jdk14</code> and <code>jdk15</code>.
4.0.0
The scope of the dependency - <code>compile</code>,
<code>runtime</code>, <code>test</code>,
<code>system</code>, and <code>provided</code>.
Used to
calculate the various classpaths used for compilation, testing, and so on. It also
assists in determining
which artifacts to include in a distribution of this project. For more
information, see
<a
href="http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">the
dependency mechanism</a>.
4.0.0
FOR SYSTEM SCOPE ONLY. Note that use of this property is
<b>discouraged</b> and may be replaced in later
versions. This specifies the path on the filesystem for this dependency.
Requires an absolute path for the value, not relative.
Use a property that gives the machine specific absolute path,
e.g. <code>${java.home}</code>.
4.0.0
Lists a set of artifacts that should be excluded from this dependency's
artifact list when it comes to
calculating transitive dependencies.
4.0.0
Indicates the dependency is optional for use of this library. While the version of
the dependency will be
taken into account for dependency calculation if the library is used elsewhere,
it will not be passed on
transitively.
4.0.0
4.0.0
The artifact ID of the project to
exclude.
4.0.0
The group ID of the project to
exclude.
4.0.0
Section for management of reports
and their configuration.
4.0.0
If true, then the default reports
are not included in the site generation. This includes the
reports in the "Project Info" menu.
4.0.0
Where to store all of the generated reports. The default is
<code>${project.build.directory}/site</code>
.
4.0.0
The reporting plugins to use and
their configuration.
4.0.0
4.0.0
The group ID of the reporting
plugin in the repository.
4.0.0
The artifact ID of the reporting
plugin in the repository.
4.0.0
The version of the reporting
plugin to be used.
4.0.0
Whether the configuration in this
plugin should be made available to projects that
inherit from this one.
4.0.0
The configuration of the
reporting plugin.
4.0.0
Multiple specifications of a set
of reports, each having (possibly) different
configuration. This is the reporting parallel to an <code>execution</code>
in the build.
4.0.0
Represents a set of reports and
configuration to be used to generate them.
0.0.0+
The unique id for this report
set, to be used during POM inheritance.
4.0.0
Configuration of the report to be
used when generating this set.
4.0.0
Whether any configuration should be propagated to child POMs.
4.0.0
The list of reports from this plugin which should be generated from this set.
3.0.0+
3.0.0+
The default goal (or phase in Maven 2) to execute when none is specified for
the project.
3.0.0+
This element describes all of the classpath resources such as properties files
associated with a
project. These resources are often included in the final package.
4.0.0
This element describes all of the classpath resources such as properties files
associated with a
project's unit tests.
4.0.0
The directory where all files generated by the build are placed.
4.0.0
The filename (excluding the extension, and with no path information) that the
produced artifact
will be called. The default value is
<code>${artifactId}-${version}</code>.
4.0.0
The list of filter properties files that are used when filtering is enabled.
4.0.0
Default plugin information to be made available for reference by
projects derived from this one. This plugin configuration will not
be resolved or bound to the lifecycle unless referenced. Any local
configuration for a given plugin will override the plugin's entire
definition here.
4.0.0
The list of plugins to use.
4.0.0
4.0.0
The group ID of the plugin in the
repository.
4.0.0
The artifact ID of the plugin in
the repository.
4.0.0
The version (or valid range of
verisons) of the plugin to be used.
4.0.0
Whether to load Maven extensions
(such as packaging and type handlers) from this
plugin. For performance reasons, this should only be enabled when necessary.
4.0.0
Multiple specifications of a set
of goals to execute during the build lifecycle, each having
(possibly) different
configuration.
4.0.0
Additional dependencies that this
project needs to introduce to the plugin's
classloader.
4.0.0
<b>Deprecated</b>. Unused by Maven.
4.0.0
Whether any configuration should be propagated to child POMs.
0.0.0+
4.0.0
4.0.0
The identifier of this execution
for labelling the goals during the build, and for matching
exections to merge during inheritance.
4.0.0
The build lifecycle phase to bind
the goals in this execution to. If omitted, the goals will
be bound to the default specified in their metadata.
4.0.0
The goals to execute with the
given configuration.
4.0.0
Whether any configuration should be propagated to child POMs.
0.0.0+
4.0.0
Section for management of default plugin information for use in a group of POMs.
4.0.0
The list of plugins to use.
3.0.0+
This element describes all of the classpath resources associated with a project
or
unit tests.
3.0.0+
Describe the resource target path. For example, if you want that
resource to appear in a specific package
(<code>org.apache.maven.messages</code>), you must specify
this
element with this value: <code>org/apache/maven/messages</code>.
This is not required if you simply put the resources in that directory
structure at the source, however.
3.0.0+
Whether resources are filtered to replace tokens with parameterised values or
not.
The values are taken from the <code>properties</code> element and
from the properties in the files listed
in the <code>filters</code> element.
3.0.0+
Describe the directory where the resources are stored.
The path is relative to the POM.
3.0.0+
A list of patterns to include,
e.g. <code>**/*.xml</code>.
3.0.0+
A list of patterns to exclude,
e.g. <code>**/*.xml</code>
4.0.0
This elements describes all that pertains to distribution for a project.
It is primarily used for deployment of artifacts and the site
produced by the build.
4.0.0
Information needed to deploy the artifacts generated by the project to a remote
repository.
4.0.0
Where to deploy snapshots of artifacts to. If not given, it defaults to the
<code>repository</code> element.
4.0.0
Information needed for deploying the web site of the project.
4.0.0+
The URL of the project's download page. If not given users will be
referred to the homepage given by
<code>url</code>. This is given to assist in locating artifacts that are not in the
repository due to
licensing restrictions.
4.0.0
Relocation information of the artifact if it has been moved to a new group ID and/or
artifact ID.
4.0.0
Gives the status of this artifact in the remote repository. This must not be
set in your local
project, as it is updated by tools placing it in the reposiory. Valid values are:
<code>none</code> (default),
<code>converted</code> (repository manager converted this from
an Maven 1 POM), <code>partner</code>
(directly synced from a partner Maven 2 repository),
<code>deployed</code> (was deployed from a Maven 2
instance), <code>verified</code> (has been hand verified as correct and
final).
4.0.0
Contains the information needed for deploying websites.
4.0.0
A unique identifier for a deployment locataion. This is used to match the
site to configuration in
the <code>settings.xml</code> file, for example.
4.0.0
Human readable name of the deployment location.
4.0.0
The url of the location where website is deployed, in the form
<code>protocol://hostname/path</code>.
4.0.0
Describes where an artifact has
moved to. If any of the values are omitted, it is assumed to be the
same as it was before.
4.0.0
The group ID the artifact has
moved to.
4.0.0
The new artifact ID of the
artifact.
4.0.0
The new version of the artifact.
4.0.0
An additional message to show the
user about the move, such as the reason.
4.0.0
Repository contains the information needed for deploying to the remote repoistory.
4.0.0
Whether to assign snapshots a
unique version comprised of the timestamp and build number, or to
use the same version each time
4.0.0
A unique identifier for a repository. This is used to match the repository
to configuration in
the <code>settings.xml</code> file, for example.
4.0.0
Human readable name of the repository.
4.0.0
The url of the repository, in the form
<code>protocol://hostname/path</code>.
4.0.0
The type of layout this repository uses for locating and storing artifacts -
can be <code>legacy</code> or
<code>default</code>.
4.0.0
A repository contains the information needed for establishing connections
with remote repoistory.
4.0.0
How to handle downloading of
releases from this repository.
4.0.0
How to handle downloading of
snapshots from this repository.
4.0.0
A unique identifier for a repository. This is used to match the repository
to configuration in
the <code>settings.xml</code> file, for example.
4.0.0
Human readable name of the repository.
4.0.0
The url of the repository, in the form
<code>protocol://hostname/path</code>.
4.0.0
The type of layout this repository uses for locating and storing artifacts -
can be <code>legacy</code> or
<code>default</code>.
4.0.0
Download policy
4.0.0
Whether to use this repository
for downloading this type of artifact.
4.0.0
The frequency for downloading updates - can be
<code>always,</code>
<code>daily</code>
(default),
<code>interval:XXX</code>
(in minutes) or
<code>never</code>
(only if it doesn't exist locally).
4.0.0
What to do when verification of an artifact checksum fails. Valid values are
<code>ignore</code>
,
<code>fail</code>
or
<code>warn</code>
(the default).
3.0.0+
This element describes all of the mailing lists associated with
a project. The auto-generated site references this information.
3.0.0+
The name of the mailing list.
3.0.0+
The email address or link that can be used to subscribe to the mailing list.
If this is an email address, a
<code>mailto:</code> link will automatically be created when
the documentation is created.
3.0.0+
The email address or link that can be used to unsubscribe to
the mailing list. If this is an email address, a
<code>mailto:</code> link will automatically be created
when the documentation is created.
3.0.0+
The email address or link that can be used to post to
the mailing list. If this is an email address, a
<code>mailto:</code> link will automatically be created
when the documentation is created.
3.0.0+
The link to a URL where you can browse the mailing list archive.
3.0.0+
The link to alternate URLs where you can browse the list archive.
3.0.0+
3.0.0+
This element specifies a directory containing the source
of the project. The generated build system will compile
the source in this directory when the project is built.
The path given is relative to the project descriptor.
4.0.0
This element specifies a directory containing the script sources
of the project. This directory is meant to be different from the
sourceDirectory, in that its contents will be copied to the output
directory in most cases (since scripts are interpreted rather than
compiled).
4.0.0
This element specifies a directory containing the unit test
source of the project. The generated build system will
compile these directories when the project is being tested.
The path given is relative to the project descriptor.
4.0.0
The directory where compiled application classes are placed.
4.0.0
The directory where compiled test classes are placed.
4.0.0
A set of build extensions to use
from this project.
3.0.0+
The default goal (or phase in Maven 2) to execute when none is specified for
the project.
3.0.0+
This element describes all of the classpath resources such as properties files
associated with a
project. These resources are often included in the final package.
4.0.0
This element describes all of the classpath resources such as properties files
associated with a
project's unit tests.
4.0.0
The directory where all files generated by the build are placed.
4.0.0
The filename (excluding the extension, and with no path information) that the
produced artifact
will be called. The default value is
<code>${artifactId}-${version}</code>.
4.0.0
The list of filter properties files that are used when filtering is enabled.
4.0.0
Default plugin information to be made available for reference by
projects derived from this one. This plugin configuration will not
be resolved or bound to the lifecycle unless referenced. Any local
configuration for a given plugin will override the plugin's entire
definition here.
4.0.0
The list of plugins to use.
4.0.0
Describes a build extension to
utilise.
4.0.0
The group ID of the
extension's artifact.
4.0.0
The artifact ID of the extension.
4.0.0
The version of the extension.
4.0.0
Information about the issue tracking (or bug tracking) system used to manage this
project.
4.0.0
The name of the issue management
system, e.g. Bugzilla
4.0.0
URL for the issue management
system used by the project.
4.0.0
4.0.0
The artifact id of the parent
project to inherit from.
4.0.0
The group id of the parent
project to inherit from.
4.0.0
The version of the parent project
to inherit.
4.0.0
The relative path of the parent <code>pom.xml</code> file within
the check out.
The default value is <code>../pom.xml</code>.
Maven looks for the parent pom first in the reactor of currently building
projects, then in this location on
the filesystem, then the local repository, and lastly in the remote repo.
<code>relativePath</code> allows you to select a different
location,
for example when your structure is flat, or deeper without an intermediate
parent pom.
However, the group ID, artifact ID and version are still required,
and must match the file in the location given or it will revert to the
repository for the POM.
This feature is only for enhancing the development in a local checkout of that
project.
4.0.0
Describes the prerequisites a
project can have.
4.0.0
The minimum version of Maven
required to build the project, or to use this plugin.
4.0.0
4.0.0
The name of the continuous integration system, e.g.
<code>continuum</code>.
4.0.0
URL for the continuous integration system used by the project if it has a web
interface.
4.0.0
Configuration for notifying developers/users when a build is
unsuccessful, including user information and notification mode.
4.0.0
Configures one method for notifying users/developers when a build breaks.
4.0.0
The mechanism used to deliver
notifications.
4.0.0
Whether to send notifications on
error.
4.0.0
Whether to send notifications on
failure.
4.0.0
Whether to send notifications on
success.
4.0.0
Whether to send notifications on
warning.
4.0.0
<b>Deprecated</b>. Where to send the notification to - eg email address.
0.0.0+
Extended configuration specific
to this notifier goes here.
3.0.0+
Describes the licenses for this project. This is used to generate
the license page of the project's web site, as well as being taken into
consideration in other reporting and
validation. The licenses listed for the project are that of the project itself, and not
of dependencies.
3.0.0+
The full legal name of the
license.
3.0.0+
The official url for the license
text.
3.0.0+
The primary method by which this project may be distributed.
<dl>
<dt>repo</dt>
<dd>may be downloaded from the Maven repository</dd>
<dt>manual</dt>
<dd>user must manually download and install the dependency.</dd>
</dl>
3.0.0+
Addendum information pertaining to this license.
3.0.0+
Information about one of the committers on this project.
3.0.0+
The unique ID of the developer in
the SCM.
3.0.0+
The full name of the contributor.
3.0.0+
The email address of the
contributor.
3.0.0+
The URL for the homepage of the
contributor.
3.0.0+
The organization to which the
contributor belongs.
3.0.0+
The URL of the organization.
3.0.0+
The roles the contributor plays in the project. Each role is
described by a <code>role</code> element, the body of which is a
role name. This can also be used to describe the contribution.
3.0.0+
The timezone the contributor is in. This is a number in the range -11 to 12.
3.0.0+
Properties about the contributor, such as an instant messenger handle.
4.0.0
4.0.0
The source control management system URL
that describes the repository and how to connect to the
repository. For more information, see the
<a href="http://maven.apache.org/scm/scm-url-format.html">URL
format</a>
and <a
href="http://maven.apache.org/scm/scms-overview.html">list of
supported SCMs</a>.
This connection is read-only.
4.0.0
Just like <code>connection</code>, but for developers, i.e. this
scm connection
will not be read only.
4.0.0
The tag of current code. By default, it's set to HEAD during
development.
4.0.0
The URL to the project's browsable SCM repository, such as ViewVC or
Fisheye.
3.0.0+
Specifies the organization that
produces this project.
3.0.0+
The full name of the
organization.
3.0.0+
The URL to the
organization's home page.