maven.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 07 Jan 2015 20:02:07 +0200
changeset 1662 2fc04c90ddd3
parent 1632 e04a32e3e1d6
child 1663 01e26f1cb256
permissions -rw-r--r--
Introduction to the Standard Directory Layout.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1395
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
.. -*- coding: utf-8; -*-
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
.. include:: HEADER.rst
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
========
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
 Maven.
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
========
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
.. contents::
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
1396
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
     9
Maven tutorial.
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    10
===============
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    11
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    12
 * http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
1450
e39ad9b6224a http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1447
diff changeset
    13
 * http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
1396
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    14
1439
afa9be44e23c Maven FAQ.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1421
diff changeset
    15
Maven FAQ.
afa9be44e23c Maven FAQ.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1421
diff changeset
    16
==========
afa9be44e23c Maven FAQ.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1421
diff changeset
    17
afa9be44e23c Maven FAQ.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1421
diff changeset
    18
 * http://maven.apache.org/general.html
afa9be44e23c Maven FAQ.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1421
diff changeset
    19
1440
712f5bd9d59b Maven plugins.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1439
diff changeset
    20
Maven plugins.
712f5bd9d59b Maven plugins.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1439
diff changeset
    21
==============
712f5bd9d59b Maven plugins.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1439
diff changeset
    22
712f5bd9d59b Maven plugins.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1439
diff changeset
    23
 * http://maven.apache.org/plugins/
712f5bd9d59b Maven plugins.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1439
diff changeset
    24
1581
84a5029867c2 Maven config location.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1580
diff changeset
    25
Maven config location.
84a5029867c2 Maven config location.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1580
diff changeset
    26
======================
84a5029867c2 Maven config location.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1580
diff changeset
    27
84a5029867c2 Maven config location.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1580
diff changeset
    28
``~/.m2/settings.xml``.
84a5029867c2 Maven config location.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1580
diff changeset
    29
1396
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    30
Generate simple project.
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    31
========================
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    32
::
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    33
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    34
  $ mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
f5ac2d7c9317 Maven tutorial. Generate simple project.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1395
diff changeset
    35
1662
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    36
Project directory layout.
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    37
=========================
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    38
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    39
  http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    40
    Introduction to the Standard Directory Layout.
2fc04c90ddd3 Introduction to the Standard Directory Layout.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1632
diff changeset
    41
1395
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
Search for maven artifact by Java package or class name.
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
========================================================
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
 * https://repository.sonatype.org/
1445
4920ffd155a4 http://search.maven.org/
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1440
diff changeset
    46
 * http://search.maven.org/
1395
afa2a45a49fa Search for maven artifact by Java package or class name.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
1397
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    48
Get help on Maven plug-in.
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    49
==========================
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    50
::
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    51
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    52
  $ mvn help:describe -DartifactId=maven-war-plugin -DgroupId=org.apache.maven.plugins
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    53
  $ mvn help:describe -Dcmd=dependency:resolve -Ddetail
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    54
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    55
  $ mvn dependency:tree
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    56
  $ mvn dependency:list
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    57
  $ mvn dependency:resolve
1421
fc5af9009abf mvn dependency:resolve-plugins
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1414
diff changeset
    58
  $ mvn dependency:resolve-plugins
1397
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    59
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    60
  $ mvn -X ...
d96348dbf006 Get help on Maven plug-in.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1396
diff changeset
    61
1465
5f87a35ab2b8 Reason for inclusion or omitting dependencies.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1454
diff changeset
    62
Reason for inclusion or omitting dependencies::
5f87a35ab2b8 Reason for inclusion or omitting dependencies.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1454
diff changeset
    63
5f87a35ab2b8 Reason for inclusion or omitting dependencies.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1454
diff changeset
    64
  $ mvn dependency:tree -Dverbose=true
5f87a35ab2b8 Reason for inclusion or omitting dependencies.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1454
diff changeset
    65
1580
638073b869c6 Fix docs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1512
diff changeset
    66
What actual code processed by Maven (dump Maven config)::
1412
77b08d4c703b What actual code processed by Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1398
diff changeset
    67
1414
a1792156210d mvn help:effective-settings
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1413
diff changeset
    68
  $ mvn help:effective-settings
1412
77b08d4c703b What actual code processed by Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1398
diff changeset
    69
  $ mvn help:effective-pom
77b08d4c703b What actual code processed by Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1398
diff changeset
    70
1398
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    71
Run Java main from Maven.
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    72
=========================
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    73
::
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    74
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    75
  mvn exec:java -Dexec.mainClass="com.vineetmanohar.module.Main" -Dexec.args="arg0 arg1 arg2"
c96c3d6857ea Run Java main from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1397
diff changeset
    76
1446
6c935c71520e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1445
diff changeset
    77
How to run single unit test?
6c935c71520e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1445
diff changeset
    78
============================
1512
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    79
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    80
``test`` property substituded to ``**/${test}.java`` pattern and override any
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    81
include/exclude patterns::
1446
6c935c71520e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1445
diff changeset
    82
6c935c71520e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1445
diff changeset
    83
  $ mvn test -Dtest=SeriousComponentTest
6c935c71520e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1445
diff changeset
    84
1512
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    85
or mostly same::
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    86
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    87
  $ mvn test-compile surefire:test -Dtest=RunMe
db0fedd5662e How to run single unit test?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1465
diff changeset
    88
1413
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    89
How do I skip the tests during the default lifecycle?
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    90
=====================================================
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    91
::
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    92
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    93
  $ mvn -DskipTests package
07f163d43116 How do I skip the tests during the default lifecycle?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1412
diff changeset
    94
1454
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
    95
Download all external dependencies sources and javadocs.
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
    96
========================================================
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
    97
::
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
    98
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
    99
  mvn dependency:resolve -Dclassifier=javadoc
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
   100
  mvn dependency:resolve -Dclassifier=sources
1c80f90d5a44 Download all external dependencies sources and javadocs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1450
diff changeset
   101
1632
e04a32e3e1d6 Fix typo.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1631
diff changeset
   102
Deploy parent pom without building children.
e04a32e3e1d6 Fix typo.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1631
diff changeset
   103
============================================
1631
d18d900b5023 Deploy parent pom without building childs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1581
diff changeset
   104
::
d18d900b5023 Deploy parent pom without building childs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1581
diff changeset
   105
d18d900b5023 Deploy parent pom without building childs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1581
diff changeset
   106
  $ mvn -N deploy
d18d900b5023 Deploy parent pom without building childs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1581
diff changeset
   107
1447
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   108
Run Ant from Maven.
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   109
===================
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   110
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   111
 * https://support.sonatype.com/entries/20736282-executing-an-external-ant-script-in-a-maven-build
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   112
 * https://support.sonatype.com/entries/20723081-running-an-inline-ant-script-in-a-maven-build
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   113
 * https://support.sonatype.com/entries/20744068-writing-a-maven-plugin-with-ant
d4399aacf09e Run Ant from Maven.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1446
diff changeset
   114