site:jar
Full name:
org.apache.maven.plugins:maven-site-plugin:4.0.0-M3:jar
Description:
Bundles the site output into a JAR so that it can be deployed to a
repository.
Attributes:
- Requires a Maven project to be executed.
- Executes only as a reportSet (reporting goal).
- Requires dependency resolution of artifacts in scope:
test. - The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
2.0-beta-6. - Binds by default to the lifecycle phase:
package.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<finalName> |
String |
2.0-beta-6 |
Specifies the filename that will be used for the generated jar
file. Please note that "-site" will be appended to the file name. User property is: project.build.finalName. |
<jarOutputDirectory> |
String |
2.0-beta-6 |
Specifies the directory where the generated jar file will be put. User property is: project.build.directory. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<archive> |
MavenArchiveConfiguration |
3.1 |
The archive configuration to use. See Maven
Archiver Reference. |
<archiveExcludes> |
String[] |
3.1 |
List of files to exclude. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
into the JAR. |
<archiveIncludes> |
String[] |
3.1 |
List of files to include. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
into the JAR. |
<attach> |
boolean |
2.0-beta-6 |
Specifies whether to attach the generated artifact to the project. Default value is: true.User property is: site.attach. |
<attributes> |
Map |
2.0-beta-6 |
Additional template properties for rendering the site. See Doxia Site
Renderer. |
<generateProjectInfo> |
boolean |
2.3 |
Whether to generate the summary page for project reports:
project-info.html. Default value is: true.User property is: generateProjectInfo. |
<generateReports> |
boolean |
2.0-beta-6 |
Convenience parameter that allows you to disable report generation. Default value is: true.User property is: generateReports. |
<generateSitemap> |
boolean |
2.1 |
Generate a sitemap. The result will be a "sitemap.html" file at the
site root. Default value is: false.User property is: generateSitemap. |
<generatedSiteDirectory> |
File |
2.0-beta-6 |
Directory containing generated documentation in source format
(Doxia supported markup). This is used to pick up other source docs
that might have been generated at build time (by reports or any
other build time mean). This directory is expected to have the same
structure as siteDirectory (ie. one directory per
Doxia-source-supported markup types). todo should we deprecate in
favour of reports directly using Doxia Sink API, without this Doxia
source intermediate step?Default value is: ${project.build.directory}/generated-site.Alias is: workingDirectory. |
<inputEncoding> |
String |
2.3 |
Specifies the input encoding. Default value is: ${project.build.sourceEncoding}.User property is: encoding. |
<locales> |
String |
2.3 |
A comma separated list of locales to render. The first valid token
will be the default Locale for this site. Default value is: en.User property is: locales. |
<moduleExcludes> |
Map |
2.0-beta-6 |
Module type exclusion mappings ex: fml ->
**/*-m1.fml (excludes fml files ending in '-m1.fml'
recursively) The configuration looks like this:
<moduleExcludes>
<moduleType>filename1.ext,**/*sample.ext</moduleType>
<!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
<!-- The value is a comma separated list of -->
<!-- filenames or fileset patterns. -->
<!-- Here's an example: -->
<xdoc>changes.xml,navigation.xml</xdoc>
</moduleExcludes>
|
<outputDirectory> |
File |
2.0-beta-6 |
Directory where the project sites and report distributions will be
generated (as html/css/...). Default value is: ${project.reporting.outputDirectory}.User property is: siteOutputDirectory. |
<outputEncoding> |
String |
2.3 |
Specifies the output encoding. Default value is: ${project.reporting.outputEncoding}.User property is: outputEncoding. |
<outputTimestamp> |
String |
3.9.0 |
Timestamp for reproducible output archive entries, either formatted
as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int
representing seconds since the epoch (like SOURCE_DATE_EPOCH).Default value is: ${project.build.outputTimestamp}. |
<relativizeDecorationLinks> |
boolean |
2.3 |
Make links in the site descriptor relative to the project URL. By
default, any absolute links that appear in the site descriptor,
e.g. banner hrefs, breadcrumbs, menu links, etc., will be made
relative to project.url. Links will not be changed if this is set
to false, or if the project has no URL defined. Default value is: true.User property is: relativizeDecorationLinks. |
<saveProcessedContent> |
boolean |
3.5 |
Whether to save Velocity processed Doxia content
(*.<ext>.vm) to
${generatedSiteDirectory}/processed. |
<siteDirectory> |
File |
2.3 |
Directory containing the site.xml file and the source
for hand written docs (one directory per Doxia-source-supported
markup types): see Doxia
Markup Languages References).Default value is: ${basedir}/src/site. |
<skip> |
boolean |
3.0 |
Set this to 'true' to skip site generation and staging. Default value is: false.User property is: maven.site.skip. |
<validate> |
boolean |
2.1.1 |
Whether to validate xml input documents. If set to true,
all input documents in xml format (in particular
xdoc and fml) will be validated and any error will lead to a build
failure. Default value is: false.User property is: validate. |
<xdocDirectory> |
File |
2.0-beta-6 |
Deprecated. use the standard m2 directory layout Default value is: ${basedir}/xdocs. |
Parameter Details
<archive>
The archive configuration to use. See Maven
Archiver Reference.
- Type:
org.apache.maven.archiver.MavenArchiveConfiguration - Since:
3.1 - Required:
No
<archiveExcludes>
List of files to exclude. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
into the JAR.
- Type:
java.lang.String[] - Since:
3.1 - Required:
No
<archiveIncludes>
List of files to include. Specified as file set patterns which are
relative to the input directory whose contents is being packaged
into the JAR.
- Type:
java.lang.String[] - Since:
3.1 - Required:
No
<attach>
Specifies whether to attach the generated artifact to the project.
- Type:
boolean - Since:
2.0-beta-6 - Required:
No - User Property:
site.attach - Default:
true
<attributes>
Additional template properties for rendering the site. See Doxia Site
Renderer.
- Type:
java.util.Map - Since:
2.0-beta-6 - Required:
No
<finalName>
Specifies the filename that will be used for the generated jar
file. Please note that "-site" will be appended to the file name.
- Type:
java.lang.String - Since:
2.0-beta-6 - Required:
Yes - User Property:
project.build.finalName
<generateProjectInfo>
Whether to generate the summary page for project reports:
project-info.html.
- Type:
boolean - Since:
2.3 - Required:
No - User Property:
generateProjectInfo - Default:
true
<generateReports>
Convenience parameter that allows you to disable report generation.
- Type:
boolean - Since:
2.0-beta-6 - Required:
No - User Property:
generateReports - Default:
true
<generateSitemap>
Generate a sitemap. The result will be a "sitemap.html" file at the
site root.
- Type:
boolean - Since:
2.1 - Required:
No - User Property:
generateSitemap - Default:
false
<generatedSiteDirectory>
Directory containing generated documentation in source format
(Doxia supported markup). This is used to pick up other source docs
that might have been generated at build time (by reports or any
other build time mean). This directory is expected to have the same
structure as
siteDirectory (ie. one directory per
Doxia-source-supported markup types). todo should we deprecate in
favour of reports directly using Doxia Sink API, without this Doxia
source intermediate step?- Type:
java.io.File - Since:
2.0-beta-6 - Required:
No - Default:
${project.build.directory}/generated-site - Alias:
workingDirectory
<inputEncoding>
Specifies the input encoding.
- Type:
java.lang.String - Since:
2.3 - Required:
No - User Property:
encoding - Default:
${project.build.sourceEncoding}
<jarOutputDirectory>
Specifies the directory where the generated jar file will be put.
- Type:
java.lang.String - Since:
2.0-beta-6 - Required:
Yes - User Property:
project.build.directory
<locales>
A comma separated list of locales to render. The first valid token
will be the default Locale for this site.
- Type:
java.lang.String - Since:
2.3 - Required:
No - User Property:
locales - Default:
en
<moduleExcludes>
Module type exclusion mappings ex:
fml ->
**/*-m1.fml (excludes fml files ending in '-m1.fml'
recursively) The configuration looks like this:
<moduleExcludes>
<moduleType>filename1.ext,**/*sample.ext</moduleType>
<!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
<!-- The value is a comma separated list of -->
<!-- filenames or fileset patterns. -->
<!-- Here's an example: -->
<xdoc>changes.xml,navigation.xml</xdoc>
</moduleExcludes>
- Type:
java.util.Map - Since:
2.0-beta-6 - Required:
No
<outputDirectory>
Directory where the project sites and report distributions will be
generated (as html/css/...).
- Type:
java.io.File - Since:
2.0-beta-6 - Required:
No - User Property:
siteOutputDirectory - Default:
${project.reporting.outputDirectory}
<outputEncoding>
Specifies the output encoding.
- Type:
java.lang.String - Since:
2.3 - Required:
No - User Property:
outputEncoding - Default:
${project.reporting.outputEncoding}
<outputTimestamp>
Timestamp for reproducible output archive entries, either formatted
as ISO 8601
yyyy-MM-dd'T'HH:mm:ssXXX or as an int
representing seconds since the epoch (like SOURCE_DATE_EPOCH).- Type:
java.lang.String - Since:
3.9.0 - Required:
No - Default:
${project.build.outputTimestamp}
<relativizeDecorationLinks>
Make links in the site descriptor relative to the project URL. By
default, any absolute links that appear in the site descriptor,
e.g. banner hrefs, breadcrumbs, menu links, etc., will be made
relative to project.url. Links will not be changed if this is set
to false, or if the project has no URL defined.
- Type:
boolean - Since:
2.3 - Required:
No - User Property:
relativizeDecorationLinks - Default:
true
<saveProcessedContent>
Whether to save Velocity processed Doxia content
(
*.<ext>.vm) to
${generatedSiteDirectory}/processed.- Type:
boolean - Since:
3.5 - Required:
No
<siteDirectory>
Directory containing the
site.xml file and the source
for hand written docs (one directory per Doxia-source-supported
markup types): see Doxia
Markup Languages References).- Type:
java.io.File - Since:
2.3 - Required:
No - Default:
${basedir}/src/site
<skip>
Set this to 'true' to skip site generation and staging.
- Type:
boolean - Since:
3.0 - Required:
No - User Property:
maven.site.skip - Default:
false
<validate>
Whether to validate xml input documents. If set to true,
all input documents in xml format (in particular
xdoc and fml) will be validated and any error will lead to a build
failure.
- Type:
boolean - Since:
2.1.1 - Required:
No - User Property:
validate - Default:
false
<xdocDirectory>
Deprecated. use the standard m2 directory layout
Alternative directory for xdoc source, useful for m1 to m2
migration
- Type:
java.io.File - Since:
2.0-beta-6 - Required:
No - Default:
${basedir}/xdocs