You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2020/05/20 17:31:22 UTC
[maven-assembly-plugin] branch master updated: code vs verbatim
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-assembly-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 86cfad3 code vs verbatim
86cfad3 is described below
commit 86cfad3b681f6c7901ae82039f95880ebdbb6346
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Wed May 20 19:31:18 2020 +0200
code vs verbatim
---
src/site/apt/advanced-descriptor-topics.apt.vm | 28 +++++++++++-----------
src/site/apt/advanced-module-set-topics.apt.vm | 28 +++++++++++-----------
.../module-binary-inclusion-simple.apt.vm | 8 +++----
.../single/including-and-excluding-artifacts.apt | 8 +++----
.../apt/examples/single/using-repositories.apt.vm | 4 ++--
src/site/apt/index.apt.vm | 28 +++++++++++-----------
src/site/apt/usage.apt.vm | 4 ++--
7 files changed, 54 insertions(+), 54 deletions(-)
diff --git a/src/site/apt/advanced-descriptor-topics.apt.vm b/src/site/apt/advanced-descriptor-topics.apt.vm
index cba40f9..cca327f 100644
--- a/src/site/apt/advanced-descriptor-topics.apt.vm
+++ b/src/site/apt/advanced-descriptor-topics.apt.vm
@@ -101,7 +101,7 @@ Advanced Assembly-Descriptor Topics
In this example, we'll configure a <<<dependencySet>>> so it only includes
those <<<war>>> dependencies.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -115,7 +115,7 @@ Advanced Assembly-Descriptor Topics
</dependencySets>
[...]
</assembly>
----
++---
*** GOTCHA!
@@ -136,7 +136,7 @@ Advanced Assembly-Descriptor Topics
filter out any source-jar files (they'll be marked with a <<<sources>>>
classifier) from the binary jars.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -153,7 +153,7 @@ Advanced Assembly-Descriptor Topics
</dependencySets>
[...]
</assembly>
----
++---
* Including Subversion Metadata Directories in a FileSet
@@ -181,7 +181,7 @@ Advanced Assembly-Descriptor Topics
directories, developers should be able to download the assembly artifact and
expand it, then simply type <<<svn up>>>.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -196,7 +196,7 @@ Advanced Assembly-Descriptor Topics
</fileSets>
[...]
</assembly>
----
++---
<NOTE: You'll notice that we're excluding all target directories; these are a
form of "calculated" and otherwise transient data, and generally shouldn't be
@@ -224,7 +224,7 @@ Advanced Assembly-Descriptor Topics
a Java package name - we want to make sure the files in this directory are
included in the assembly.
----
++---
<assembly>
[...]
<fileSets>
@@ -239,7 +239,7 @@ Advanced Assembly-Descriptor Topics
</fileSets>
[...]
</assembly>
----
++---
The above <<<fileSet>>> uses a somewhat obscure feature of regular
expressions called <negative lookahead>, which means our exclude pattern
@@ -269,7 +269,7 @@ Advanced Assembly-Descriptor Topics
project's open source license language, in order to be compliant with our
software foundation's policies.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -286,7 +286,7 @@ Advanced Assembly-Descriptor Topics
</fileSets>
[...]
</assembly>
----
++---
If a developer inadvertently removes the LICENSE.txt from the project
directory, the assembly plugin should refuse to build this assembly.
@@ -317,7 +317,7 @@ Advanced Assembly-Descriptor Topics
<<<maven-core>>> project, which means we shouldn't use the <<<artifactId>>> as
part of the assembly root directory.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -325,13 +325,13 @@ Advanced Assembly-Descriptor Topics
<baseDirectory>maven</baseDirectory>
[...]
</assembly>
----
++---
Now, imagine that the distribution assembly were created in the top-level
<<<maven>>> project. Now, we <can> use the <<<artifactId>>>, and probably
should, just to minimize the maintenance of these files.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -339,7 +339,7 @@ Advanced Assembly-Descriptor Topics
<baseDirectory>${artifactId}</baseDirectory>
[...]
</assembly>
----
++---
* Advanced ModuleSet Topics
diff --git a/src/site/apt/advanced-module-set-topics.apt.vm b/src/site/apt/advanced-module-set-topics.apt.vm
index f49e171..a57e593 100644
--- a/src/site/apt/advanced-module-set-topics.apt.vm
+++ b/src/site/apt/advanced-module-set-topics.apt.vm
@@ -75,7 +75,7 @@ Advanced Module-Set Topics
We can select <<just>> the child1 module using the following <<<moduleSet>>>:
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -90,7 +90,7 @@ Advanced Module-Set Topics
</moduleSets>
[...]
</assembly>
----
++---
<NOTE: It's important to remember that, if the child1 project itself had
children, those children would not be included just because the child1 project
@@ -159,7 +159,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
for each module selected by the moduleSet. This is useful to provide a source
reference for your project to users.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -178,7 +178,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
</moduleSet>
</moduleSets>
</assembly>
----
++---
** Example: Including a buildable project directory for each selected module
@@ -187,7 +187,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
give your users the chance to tinker with your project, then build it on their
own.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -208,7 +208,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
</moduleSet>
</moduleSets>
</assembly>
----
++---
<NOTE: We exclude the target directory, since this is assumed to be temporary
storage for files produced during the course of a Maven build. Permanent
@@ -231,7 +231,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
consolidated source directory containing all of the source files from your
multimodule hierarchy.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -254,7 +254,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
</moduleSet>
</moduleSets>
</assembly>
----
++---
** Excluding Modules of Modules from Direct Assembly Processing
@@ -336,7 +336,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
To accomplish this restructuring, simply use the
<<<excludeSubModuleDirectories>>> flag, as follows:
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -358,7 +358,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
</moduleSet>
</moduleSets>
</assembly>
----
++---
* {Including Module Binaries}
@@ -418,7 +418,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
attached artifact in that module, we'll need to extract that artifact instead
of the main project artifact.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -437,7 +437,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
[...]
</moduleSets>
</assembly>
----
++---
** Excluding Module Dependencies
@@ -473,7 +473,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
contains all of the module dependencies, so it's not necessary to include this
module's dependencies in the current assembly.
----
++---
<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd">
@@ -492,7 +492,7 @@ ${module.groupId}-${module.artifactId}-${module.version}.${module.extension}
[...]
</moduleSets>
</assembly>
----
++---
<NOTE: The> <<<binaries>>> <section still accommodates direct> <<<\<includes/\>>>>
<and> <<<\<excludes/\>>>> <subsections, for specifying which module-dependencies
diff --git a/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm b/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm
index 722b6de..bafa017 100644
--- a/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm
+++ b/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt.vm
@@ -214,9 +214,9 @@ Including Module Binaries
To build the assembly, we issue the following command:
-+---+
+-----
mvn clean package
-+---+
+-----
This will ensure that the output directory (normally, <<<target>>>), is
removed before building the assembly directory.
@@ -234,11 +234,11 @@ mvn clean package
Here are the directory contents:
-+---+
+-----
target/distribution/distribution-1.0-bin
`-- modules
`-- child1
|-- child1-1.0.jar
`-- junit-3.8.1.jar
-+---+
+-----
diff --git a/src/site/apt/examples/single/including-and-excluding-artifacts.apt b/src/site/apt/examples/single/including-and-excluding-artifacts.apt
index 42b4338..532d999 100644
--- a/src/site/apt/examples/single/including-and-excluding-artifacts.apt
+++ b/src/site/apt/examples/single/including-and-excluding-artifacts.apt
@@ -45,7 +45,7 @@ Including and Excluding Artifacts
Your pom might include something like:
------
++-----
<dependencies>
<dependency>
<groupId>YOUR GROUP</groupId>
@@ -54,13 +54,13 @@ Including and Excluding Artifacts
<classifier>bin</classifier>
<type>zip</type>
</dependency>
------
++-----
And then in your assembly you exclude all the jar dependencies pulled in
from the binary assembly. In this example the commons-lang and log4j jars
are included unnecessarily (as they are in the bin.zip file already)
------
++-----
<dependencySets>
<dependencySet>
....
@@ -71,7 +71,7 @@ Including and Excluding Artifacts
</dependencySet>
....
</dependencySets>
------
++-----
* What about your Project's Artifacts?
diff --git a/src/site/apt/examples/single/using-repositories.apt.vm b/src/site/apt/examples/single/using-repositories.apt.vm
index 09240b9..a8dff5c 100644
--- a/src/site/apt/examples/single/using-repositories.apt.vm
+++ b/src/site/apt/examples/single/using-repositories.apt.vm
@@ -105,7 +105,7 @@ mvn clean assembly:single
When the Maven execution completes, the archive contents should be similar to:
-+-----
+------
target/artifactId-version-repository.jar
`-- maven2
|-- groupId
@@ -128,4 +128,4 @@ target/artifactId-version-repository.jar
| `-- maven-metadata.xml.sha1
`-- groupId2
`-- [...]
-+-----
+------
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 143b98d..891a307 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -69,7 +69,7 @@ ${project.name}
If your project wants to package your artifact in an uber-jar, the assembly
plugin provides only basic support. For more control, use the
- {{{http://maven.apache.org/plugins/maven-shade-plugin/} Maven Shade Plugin}}.
+ {{{/plugins/maven-shade-plugin/} Maven Shade Plugin}}.
To use the Assembly Plugin in Maven, you simply need to:
@@ -113,23 +113,23 @@ ${project.name}
* Assembly and Component Descriptor Schemas (XSD)
- * {{{http://maven.apache.org/xsd/assembly-2.0.0.xsd}http://maven.apache.org/xsd/assembly-2.0.0.xsd}},
- {{{http://maven.apache.org/xsd/assembly-component-2.0.0.xsd}http://maven.apache.org/xsd/assembly-component-2.0.0.xsd}} (for version 3.0 and higher)
+ * {{{/xsd/assembly-2.0.0.xsd}http://maven.apache.org/xsd/assembly-2.0.0.xsd}},
+ {{{/xsd/assembly-component-2.0.0.xsd}http://maven.apache.org/xsd/assembly-component-2.0.0.xsd}} (for version 3.0 and higher)
- * {{{http://maven.apache.org/xsd/assembly-1.1.3.xsd}http://maven.apache.org/xsd/assembly-1.1.3.xsd}},
- {{{http://maven.apache.org/xsd/component-1.1.3.xsd}http://maven.apache.org/xsd/component-1.1.3.xsd}} (for version 2.5.4 and higher)
+ * {{{/xsd/assembly-1.1.3.xsd}http://maven.apache.org/xsd/assembly-1.1.3.xsd}},
+ {{{/xsd/component-1.1.3.xsd}http://maven.apache.org/xsd/component-1.1.3.xsd}} (for version 2.5.4 and higher)
- * {{{http://maven.apache.org/xsd/assembly-1.1.2.xsd}http://maven.apache.org/xsd/assembly-1.1.2.xsd}},
- {{{http://maven.apache.org/xsd/component-1.1.2.xsd}http://maven.apache.org/xsd/component-1.1.2.xsd}} (for version 2.2 and higher)
+ * {{{/xsd/assembly-1.1.2.xsd}http://maven.apache.org/xsd/assembly-1.1.2.xsd}},
+ {{{/xsd/component-1.1.2.xsd}http://maven.apache.org/xsd/component-1.1.2.xsd}} (for version 2.2 and higher)
- * {{{http://maven.apache.org/xsd/assembly-1.1.1.xsd}http://maven.apache.org/xsd/assembly-1.1.1.xsd}},
- {{{http://maven.apache.org/xsd/component-1.1.1.xsd}http://maven.apache.org/xsd/component-1.1.1.xsd}} (for version 2.2-beta-4 - 2.2-beta-5)
+ * {{{/xsd/assembly-1.1.1.xsd}http://maven.apache.org/xsd/assembly-1.1.1.xsd}},
+ {{{/xsd/component-1.1.1.xsd}http://maven.apache.org/xsd/component-1.1.1.xsd}} (for version 2.2-beta-4 - 2.2-beta-5)
- * {{{http://maven.apache.org/xsd/assembly-1.1.0.xsd}http://maven.apache.org/xsd/assembly-1.1.0.xsd}},
- {{{http://maven.apache.org/xsd/component-1.1.0.xsd}http://maven.apache.org/xsd/component-1.1.0.xsd}} (for version 2.2-beta-1 - 2.2-beta-3)
+ * {{{/xsd/assembly-1.1.0.xsd}http://maven.apache.org/xsd/assembly-1.1.0.xsd}},
+ {{{/xsd/component-1.1.0.xsd}http://maven.apache.org/xsd/component-1.1.0.xsd}} (for version 2.2-beta-1 - 2.2-beta-3)
- * {{{http://maven.apache.org/xsd/assembly-1.0.0.xsd}http://maven.apache.org/xsd/assembly-1.0.0.xsd}},
- {{{http://maven.apache.org/xsd/component-1.0.0.xsd}http://maven.apache.org/xsd/component-1.0.0.xsd}} (for version 2.1 and lower)
+ * {{{/xsd/assembly-1.0.0.xsd}http://maven.apache.org/xsd/assembly-1.0.0.xsd}},
+ {{{/xsd/component-1.0.0.xsd}http://maven.apache.org/xsd/component-1.0.0.xsd}} (for version 2.1 and lower)
[]
@@ -150,7 +150,7 @@ ${project.name}
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./scm.html}source repository}} and will find supplementary information in the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
+ {{{/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index 38b3c68..2c138ba 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -29,10 +29,10 @@
Usage
To handle filtering this version of Maven Assembly Plugin uses
- {{{http://maven.apache.org/shared/maven-filtering/index.html}Maven Filtering}} ${mavenFilteringVersion}.
+ {{{/shared/maven-filtering/index.html}Maven Filtering}} ${mavenFilteringVersion}.
To handle archiving this version of Maven Assembly Plugin uses
- {{{http://maven.apache.org/shared/maven-archiver/index.html}Maven Archiver}} ${mavenArchiverVersion}.
+ {{{/shared/maven-archiver/index.html}Maven Archiver}} ${mavenArchiverVersion}.
This document is intended to provide instructions for using the
maven-assembly-plugin. In order for this discussion to be useful, it's