You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 13:17:19 UTC
(maven-install-plugin) 02/02: Port the site documentation from APT to Markdown
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-install-plugin.git
commit 756333df9b7cae1c7b4fcc0e7c1da600737acb91
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 14:54:37 2026 +0200
Port the site documentation from APT to Markdown
6 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- references APT rendered literally are escaped, so they do not resolve
Verified by building the site before and after and comparing every
generated page: the visible text and the link targets are unchanged apart
from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
Markdown module's typographic substitution.
---
.../examples/custom-pom-installation.md.vm | 70 ++++++-------
.../markdown/examples/generic-pom-generation.md.vm | 57 ++++------
.../examples/installing-secondary-artifacts.md.vm | 61 ++++-------
.../markdown/examples/specific-local-repo.md.vm | 73 ++++++-------
src/site/markdown/index.md | 116 +++++++--------------
src/site/markdown/usage.md | 87 ++++++----------
6 files changed, 168 insertions(+), 296 deletions(-)
diff --git a/src/site/markdown/examples/custom-pom-installation.md.vm b/src/site/markdown/examples/custom-pom-installation.md.vm
index 5f8503d..dc01e5d 100644
--- a/src/site/markdown/examples/custom-pom-installation.md.vm
+++ b/src/site/markdown/examples/custom-pom-installation.md.vm
@@ -1,46 +1,34 @@
- ----
- Installing an artifact with a custom POM
- ------
- Allan Ramirez
- ------
- 2009-03-22
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Installing an artifact with a custom POM
-
- The Apache Maven Install Plugin can include a pre-built custom POM with the artifact
- in the local repository. Just set the value of the <<<pomFile>>> parameter
- to the path of the custom POM.
-
-+---+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Installing an artifact with a custom POM
+
+The Apache Maven Install Plugin can include a pre-built custom POM with the artifact in the local repository. Just set the value of the `pomFile` parameter to the path of the custom POM.
+
+```unknown
mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-your-artifact-jar -DpomFile=path-to-pom
-+---+
+```
- If the JAR was built by Apache Maven, it'll contain a pom.xml in a subfolder of the META-INF directory, which will be read by default. In that case, all you need to do is:
+If the JAR was built by Apache Maven, it'll contain a pom.xml in a subfolder of the META-INF directory, which will be read by default. In that case, all you need to do is:
-+---+
+```unknown
mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=<path-to-file>
-+---+
+```
- <<Note>>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<<mvn install:install-file>>>
- its version depends on its specification in the pom or the version of Apache Maven.
+**Note**: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using `mvn install:install-file` its version depends on its specification in the pom or the version of Apache Maven.
diff --git a/src/site/markdown/examples/generic-pom-generation.md.vm b/src/site/markdown/examples/generic-pom-generation.md.vm
index 712074f..e288c07 100644
--- a/src/site/markdown/examples/generic-pom-generation.md.vm
+++ b/src/site/markdown/examples/generic-pom-generation.md.vm
@@ -1,48 +1,33 @@
- ----
- Generating a generic POM
- ------
- Allan Ramirez
- ------
- 2009-03-22
- ------
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
-Generating a generic POM
+# Generating a generic POM
- There are times when you do not have a POM for a 3rd party artifact.
- For instance, when installing a proprietary or commercial JAR into a repository.
- The Install Plugin can create a generic POM in this case which
- contains the minimal set of POM elements required by Maven, such as groupId,
- artifactId, version, packaging. You tell Maven to generate a POM by setting the
- <<<generatePom>>> parameter to <<<true>>>.
+There are times when you do not have a POM for a 3rd party artifact. For instance, when installing a proprietary or commercial JAR into a repository. The Install Plugin can create a generic POM in this case which contains the minimal set of POM elements required by Maven, such as groupId, artifactId, version, packaging. You tell Maven to generate a POM by setting the `generatePom` parameter to `true`.
-+---+
+```unknown
mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-your-artifact-jar \
-DgroupId=your.groupId \
-DartifactId=your-artifactId \
-Dversion=version \
-Dpackaging=jar \
-DgeneratePom=true
-+---+
+```
- <<Note>>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<<mvn install:install-file>>>
- its version depends on its specification in the pom or the version of Apache Maven.
+**Note**: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using `mvn install:install-file` its version depends on its specification in the pom or the version of Apache Maven.
diff --git a/src/site/markdown/examples/installing-secondary-artifacts.md.vm b/src/site/markdown/examples/installing-secondary-artifacts.md.vm
index 201c208..22369d9 100644
--- a/src/site/markdown/examples/installing-secondary-artifacts.md.vm
+++ b/src/site/markdown/examples/installing-secondary-artifacts.md.vm
@@ -1,52 +1,35 @@
- ------
- Installing Secondary Artifacts
- ------
- Dennis Lundberg
- ------
- 2009-03-22
- ------
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
-Installing Secondary Artifacts
+# Installing Secondary Artifacts
- Sometimes you need to install secondary artifacts after the main artifact has
- been installed in your local repository. To install a secondary artifact you
- need to use the <<<classifier>>> parameter to classify the secondary artifact.
+Sometimes you need to install secondary artifacts after the main artifact has been installed in your local repository. To install a secondary artifact you need to use the `classifier` parameter to classify the secondary artifact.
- Let us assume that you want to install the sources for an old artifact, like
- commons-logging-1.0.3. The
- {{{http://repo1.maven.org/maven2/commons-logging/commons-logging/1.0.3/}central repository}}
- only has the main artifact and a <<<-javadoc>>> artifact for that version.
- Package up the sources into a JAR file on your local disk and then run the
- following command:
+Let us assume that you want to install the sources for an old artifact, like commons-logging-1.0.3. The [central repository](http://repo1.maven.org/maven2/commons-logging/commons-logging/1.0.3/) only has the main artifact and a `-javadoc` artifact for that version. Package up the sources into a JAR file on your local disk and then run the following command:
-+---+
+```unknown
mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-commons-logging-sources.jar \
-DgroupId=commons-logging \
-DartifactId=commons-logging \
-Dversion=1.0.3 \
-Dpackaging=jar \
-Dclassifier=sources
-+---+
+```
- <<Note>>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<<mvn install:install-file>>>
- its version depends on its specification in the pom or the version of Apache Maven.
+**Note**: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using `mvn install:install-file` its version depends on its specification in the pom or the version of Apache Maven.
diff --git a/src/site/markdown/examples/specific-local-repo.md.vm b/src/site/markdown/examples/specific-local-repo.md.vm
index bcf03dc..bfb5b39 100644
--- a/src/site/markdown/examples/specific-local-repo.md.vm
+++ b/src/site/markdown/examples/specific-local-repo.md.vm
@@ -1,50 +1,37 @@
- ------
- Installing an artifact to a specific local repository path
- ------
- Vincent Siveton
- Robert Scholte
- ------
- 2013-07-20
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Installing an artifact to a specific local repository path
-
- General information about how to copy jars into your local repository can be found in the
- {{{http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html}Guide to installing 3rd party JARs}}
-
- By default, the Apache Maven Install Plugin uses the local repository defined in the <<<settings.xml>>> to install an artifact.
-
- You could install an artifact on a specific local repository by setting the <<<localRepositoryPath>>>
- parameter when installing.
-
-+---+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Installing an artifact to a specific local repository path
+
+General information about how to copy jars into your local repository can be found in the [Guide to installing 3rd party JARs](http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html)
+
+By default, the Apache Maven Install Plugin uses the local repository defined in the `settings.xml` to install an artifact.
+
+You could install an artifact on a specific local repository by setting the `localRepositoryPath` parameter when installing.
+
+```unknown
mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-your-artifact-jar \
-DgroupId=your.groupId \
-DartifactId=your-artifactId \
-Dversion=version \
-Dpackaging=jar \
-DlocalRepositoryPath=path-to-specific-local-repo
-+---+
+```
- <<Note>>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<<mvn install:install-file>>>
- its version depends on its specification in the pom or the version of Apache Maven.
+**Note**: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using `mvn install:install-file` its version depends on its specification in the pom or the version of Apache Maven.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 68f5e0e..97428ee 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,95 +1,51 @@
- ------
- Introduction
- ------
- Allan Ramirez
- ------
- 2013-07-22
- ------
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
-${project.name}
+# Apache Maven Install Plugin
+The Install Plugin is used during the `install` phase to add artifact(s) to the local repository. The Install Plugin uses the information in the POM (groupId, artifactId, version) to determine the proper location for the artifact within the local repository.
- The Install Plugin is used during the <<<install>>> phase to add
- artifact(s) to the local repository. The Install Plugin uses
- the information in the POM (groupId, artifactId, version) to determine
- the proper location for the artifact within the local repository.
+The local repository is the local cache where all artifacts needed for the build are stored. By default, it is located within the user's home directory `(~/.m2/repository)` but the location can be configured in `~/.m2/settings.xml` using the `<localRepository>` element.
- The local repository is the local cache where
- all artifacts needed for the build are stored. By default, it is located within
- the user's home directory <<<(~/.m2/repository)>>> but the location can be configured in
- <<<~/.m2/settings.xml>>> using the <<<\<localRepository\>>>> element.
+## Goals Overview
-* Goals Overview
+The Install Plugin has 3 goals:
- The Install Plugin has 3 goals:
+- [install:install](./install-mojo.html) is used to automatically install the project's main artifact (the JAR, WAR or EAR), its POM and any attached artifacts (sources, javadoc, etc) produced by a particular project.
+- [install:install-file](./install-file-mojo.html) is mostly used to install an externally created artifact into the local repository, along with its POM. In that case the project information can be taken from an optionally specified pomFile, but can also be given using command line parameters.
+- [install:help](./help-mojo.html) displays help information on maven-install-plugin.
+## Important Note for Version 3.0.0+
- * {{{./install-mojo.html}install:install}} is used to automatically install the
- project's main artifact (the JAR, WAR or EAR), its POM and any attached artifacts
- (sources, javadoc, etc) produced by a particular project.
+The [install:install](./install-mojo.html) goal no longer supports creating checksums via `-DcreateChecksum=true`. Details can be found in [MINSTALL-143](https://issues.apache.org/jira/browse/MINSTALL-143).
- * {{{./install-file-mojo.html}install:install-file}} is mostly used to install an externally
- created artifact into the local repository, along with its POM. In that case
- the project information can be taken from an optionally specified pomFile, but can
- also be given using command line parameters.
+## Usage
- * {{{./help-mojo.html}install:help}} displays help information on maven-install-plugin.
+General instructions for using the Install Plugin can be found on the [usage page](./usage.html). Some more specific use cases are described in the examples given below.
- []
+If you have questions about the plugin's usage, read the [FAQ](./faq.html) and feel free to contact the [user mailing list](./mailing-lists.html). Posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the [mail archive](./mailing-lists.html).
-* Important Note for Version 3.0.0+
+If you think the plugin is missing a feature or has a defect, you can file a feature request or bug report in our [issue tracker](./issue-management.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome [...]
- The {{{./install-mojo.html}install:install}} goal no longer supports creating checksums
- via <<<-DcreateChecksum=true>>>. Details can be found
- in {{{https://issues.apache.org/jira/browse/MINSTALL-143}MINSTALL-143}}.
-
-* Usage
+## Examples
- General instructions for using the Install Plugin can be found on the {{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below.
+To provide you with a better understanding of some usages of the Maven Install Plugin, you can take a look into the following examples:
- If you have questions about the plugin's usage, read the {{{./faq.html}FAQ}} and feel
- free to contact the {{{./mailing-lists.html}user mailing list}}. Posts to the mailing list are archived and could
- already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
- the {{{./mailing-lists.html}mail archive}}.
-
- If you think the plugin is missing a feature or has a defect, you can file a feature request or bug report in our
- {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
- concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
- 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}}.
-
-* Examples
-
- To provide you with a better understanding of some usages of the Maven Install Plugin,
- you can take a look into the following examples:
-
- * {{{./examples/custom-pom-installation.html}Installing a Custom POM}}
-
- * {{{./examples/generic-pom-generation.html}Generating a Generic POM}}
-
- * {{{./examples/specific-local-repo.html}Installing an Artifact to a Specific Local Repository Path}}
-
- * {{{./examples/installing-secondary-artifacts.html}Installing Secondary Artifacts}}
-
- []
+- [Installing a Custom POM](./examples/custom-pom-installation.html)
+- [Generating a Generic POM](./examples/generic-pom-generation.html)
+- [Installing an Artifact to a Specific Local Repository Path](./examples/specific-local-repo.html)
+- [Installing Secondary Artifacts](./examples/installing-secondary-artifacts.html)
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index 6b37209..3cc0116 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -1,60 +1,41 @@
- ------
- Usage
- ------
- Allan Ramirez
- Robert Scholte
- ------
- 2013-07-20
- ------
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+http://www.apache.org/licenses/LICENSE-2.0
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
-Usage
+# Usage
- Apache Maven has a two level strategy to resolve and distribute files, which we call artifacts.
- The first level is called the <<<local repository>>>, which is the artifact cache on your system, by default located at <<<$\{user.home\}/.m2/repository>>>.
- When executing Maven, it first looks in this local cache for artifacts. If the artifact cannot be found here, Maven will access the remote repositories to find the artifact.
- Once found it will be stored into the local repository, so it's available for current and future usage.
-
- With the <<<maven-install-plugin>>> you can put your artifacts in the local repository. To upload artifacts to a remote repository, you need to use the
- {{{http://maven.apache.org/plugins/maven-deploy-plugin/}maven-deploy-plugin}}.
+Apache Maven has a two level strategy to resolve and distribute files, which we call artifacts. The first level is called the `local repository`, which is the artifact cache on your system, by default located at `${user.home}/.m2/repository`. When executing Maven, it first looks in this local cache for artifacts. If the artifact cannot be found here, Maven will access the remote repositories to find the artifact. Once found it will be stored into the local repository, so it's available f [...]
-* The <<<install:install>>> goal
+With the `maven-install-plugin` you can put your artifacts in the local repository. To upload artifacts to a remote repository, you need to use the [maven-deploy-plugin](http://maven.apache.org/plugins/maven-deploy-plugin/).
- In most cases, <<<install:install>>> goal doesn't need any configuration, it
- needs the project's POM and the artifact file to be installed during the
- <<<install>>> phase of the default build lifecycle.
+## The `install:install` goal
-+---+
+In most cases, `install:install` goal doesn't need any configuration, it needs the project's POM and the artifact file to be installed during the `install` phase of the default build lifecycle.
+
+```unknown
mvn install
-+---+
+```
-* The <<<install:install-file>>> goal
+## The `install:install-file` goal
- The <<<install:install-file>>> goal is used primarily for installing artifacts to
- the local repository which were not built by Maven. The project's development team
- may or may not provide a POM for the artifact. Here's a list of some of the available parameters for the
- <<<install-file>>> goal:
+The `install:install-file` goal is used primarily for installing artifacts to the local repository which were not built by Maven. The project's development team may or may not provide a POM for the artifact. Here's a list of some of the available parameters for the `install-file` goal:
-+---+
+```unknown
mvn install:install-file -Dfile=your-artifact-1.0.jar \
[-DpomFile=your-pom.xml] \
[-Dsources=src.jar] \
@@ -66,15 +47,7 @@ mvn install:install-file -Dfile=your-artifact-1.0.jar \
[-Dclassifier=sources] \
[-DgeneratePom=true] \
[-DcreateChecksum=true]
-+---+
-
- * the groupId, artifactId, version and packaging of the file to install. These can
- be taken from the specified pomFile, extracted from the pom.xml inside the artifact, and overridden or specified
- using the command line. When the pomFile contains a <parent> section, the parent's
- groupId can be considered if the groupId is not specified further for the
- current project or on the command line.
+```
- * the optional <<<classifier>>> parameter can be used to
- {{{./examples/installing-secondary-artifacts.html}install secondary artifacts}} for a project,
- like a <<<javadoc>>> or <<<sources>>> JAR. If a classifier is not given, Maven assumes the file is the main
- artifact for the project.
+- the groupId, artifactId, version and packaging of the file to install. These can be taken from the specified pomFile, extracted from the pom.xml inside the artifact, and overridden or specified using the command line. When the pomFile contains a _parent_ section, the parent's groupId can be considered if the groupId is not specified further for the current project or on the command line.
+- the optional `classifier` parameter can be used to [install secondary artifacts](./examples/installing-secondary-artifacts.html) for a project, like a `javadoc` or `sources` JAR. If a classifier is not given, Maven assumes the file is the main artifact for the project.