| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="ISO-8859-1" ?>
|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 4 | <head>
|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
|
| 6 | <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
|
| 7 | <link rel="stylesheet" href="../coverage/.resources/prettify.css" charset="ISO-8859-1" type="text/css" />
|
| 8 | <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
|
| 9 | <script type="text/javascript" src="../coverage/.resources/prettify.js"></script>
|
| 10 | <title>JaCoCo - Maven Plug-in</title>
|
| 11 | </head>
|
| 12 | <body onload="prettyPrint()">
|
| 13 |
|
| 14 | <div class="breadcrumb">
|
| 15 | <a href="../index.html" class="el_report">JaCoCo</a> >
|
| 16 | <a href="index.html" class="el_group">Documentation</a> >
|
| 17 | <span class="el_source">Maven Plug-in</span>
|
| 18 | </div>
|
| 19 | <div id="content">
|
| 20 |
|
| 21 | <h1>Maven Plug-in</h1>
|
| 22 |
|
| 23 | <p>
|
| 24 | The JaCoCo <a href="http://maven.apache.org/">Maven</a> plug-in provides the
|
| Evgeny Mandrikov | 9c24583 | 2011-07-03 21:38:03 +0000 | [diff] [blame] | 25 | JaCoCo runtime agent to your tests and allows basic report creation.
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 26 | </p>
|
| 27 |
|
| 28 | <p class="hint">
|
| 29 | If you want to have line number information included in the coverage reports
|
| 30 | or you want source code highlighting the class files of the test target must
|
| Evgeny Mandrikov | 9c24583 | 2011-07-03 21:38:03 +0000 | [diff] [blame] | 31 | be compiled with debug information.
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 32 | </p>
|
| 33 |
|
| 34 |
|
| 35 | <h2>Prerequisites</h2>
|
| 36 |
|
| 37 | <p>
|
| 38 | The JaCoCo Maven plug-in require
|
| 39 | </p>
|
| 40 |
|
| 41 | <ul>
|
| 42 | <li>Maven 2.1.0 or higher and</li>
|
| 43 | <li>Java 1.5 or higher (for both, the Maven runtime and the test executor).</li>
|
| 44 | </ul>
|
| Evgeny Mandrikov | 9c24583 | 2011-07-03 21:38:03 +0000 | [diff] [blame] | 45 |
|
| 46 |
|
| 47 | <h2>Usage</h2>
|
| 48 |
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 49 | <p>
|
| 50 | The Maven plug-in can be included in your build with the following declaration:
|
| 51 | </p>
|
| 52 |
|
| 53 | <pre class="source lang-xml linenums">
|
| 54 | <plugin>
|
| 55 | <groupId>org.jacoco</groupId>
|
| 56 | <artifactId>jacoco-maven-plugin</artifactId>
|
| 57 | <version>@qualified.bundle.version@</version>
|
| 58 | </plugin>
|
| 59 | </pre>
|
| 60 |
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 61 | <p>
|
| Evgeny Mandrikov | 9c24583 | 2011-07-03 21:38:03 +0000 | [diff] [blame] | 62 | To receive a full list of goals and available parameters you can use maven-help-plugin:
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 63 | </p>
|
| Evgeny Mandrikov | 9c24583 | 2011-07-03 21:38:03 +0000 | [diff] [blame] | 64 | <pre>
|
| 65 | mvn help:describe -Dplugin=org.jacoco:jacoco-maven-plugin -Ddetail
|
| 66 | </pre>
|
| Marc R. Hoffmann | 7981f7c | 2011-06-18 08:21:40 +0000 | [diff] [blame] | 67 |
|
| 68 | </div>
|
| 69 | <div class="footer">
|
| 70 | <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
|
| 71 | <a href="license.html">Copyright</a> © @copyright.years@ Mountainminds GmbH & Co. KG and Contributors
|
| 72 | </div>
|
| 73 |
|
| 74 | </body>
|
| 75 | </html> |