Google Git
Sign in
eclipse / gerrit / www.eclipse.org / sisu / 2b29cf9b605a82b29b06c8c32c6373fdaec472c1 / . / docs / api / org.eclipse.sisu.mojos / index.html
blob: 89f1be2ac61e4adcb62a13f685a5bfc25871b417 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2016-02-17
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Stuart McCulloch" />
<meta name="Date-Revision-yyyymmdd" content="20160217" />
<meta http-equiv="Content-Language" content="en" />
<title>Sisu Maven Plugin &#x2013; Sisu Plugin for Maven</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
</head>
<body class="topBarEnabled">
<div id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container"><div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="index.html" title="Introduction">Introduction</a>
</li>
<li> <a href="plugin-info.html" title="Goals">Goals</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html" title="Project Information">Project Information</a>
<ul class="dropdown-menu">
<li> <a href="index.html" title="About">About</a>
</li>
<li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a>
</li>
<li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a>
</li>
<li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a>
</li>
<li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
</li>
<li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
</li>
<li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
</li>
<li> <a href="plugins.html" title="Project Plugins">Project Plugins</a>
</li>
<li> <a href="license.html" title="Project License">Project License</a>
</li>
<li> <a href="team-list.html" title="Project Team">Project Team</a>
</li>
<li> <a href="project-summary.html" title="Project Summary">Project Summary</a>
</li>
<li> <a href="dependencies.html" title="Dependencies">Dependencies</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
<ul class="dropdown-menu">
<li> <a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="nav pull-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a>
<ul class="dropdown-menu">
<li> <a href="http://eclipse.org/sisu/" title="Sisu">Sisu</a>
</li>
<li> <a href="http://maven.apache.org/" title="Maven">Maven</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>Sisu Maven Plugin</h2>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2016-02-17</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.3.3</li>
</ul>
</div>
<div id="bodyColumn" >
<div class="section">
<h2><a name="Introduction"></a>Introduction</h2>
<p>The Sisu Plugin for Maven provides mojos to generate <tt>META-INF/sisu/javax.inject.Named</tt> index files for the <a class="externalLink" href="http://eclipse.org/sisu/">Sisu container</a>.</p></div>
<div class="section">
<h2><a name="Usage"></a>Usage</h2>
<div class="section">
<h3><a name="Indexing_individual_projects"></a>Indexing individual projects</h3>
<div class="source">
<pre>&lt;project&gt;
[...]
&lt;build&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.eclipse.sisu&lt;/groupId&gt;
&lt;artifactId&gt;sisu-maven-plugin&lt;/artifactId&gt;
&lt;executions&gt;
&lt;execution&gt;
&lt;id&gt;index-project&lt;/id&gt;
&lt;goals&gt;
&lt;goal&gt;main-index&lt;/goal&gt;
&lt;goal&gt;test-index&lt;/goal&gt;
&lt;/goals&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;/plugin&gt;
&lt;/plugins&gt;
&lt;/build&gt;
[...]
&lt;/project&gt;</pre></div></div>
<div class="section">
<h3><a name="Indexing_assembled_applications"></a>Indexing assembled applications</h3>
<div class="source">
<pre>&lt;project&gt;
[...]
&lt;build&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.eclipse.sisu&lt;/groupId&gt;
&lt;artifactId&gt;sisu-maven-plugin&lt;/artifactId&gt;
&lt;executions&gt;
&lt;execution&gt;
&lt;id&gt;index-dependencies&lt;/id&gt;
&lt;phase&gt;package&lt;/phase&gt;
&lt;goals&gt;
&lt;goal&gt;index&lt;/goal&gt;
&lt;/goals&gt;
&lt;configuration&gt;
&lt;!-- same include/exclude settings as maven-dependency-plugin --&gt;
&lt;/configuration&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;/plugin&gt;
&lt;/plugins&gt;
&lt;/build&gt;
[...]
&lt;/project&gt;</pre></div></div></div>
</div>
</div>
<hr/>
<footer>
<div class="container">
<div class="row span12">Copyright &copy; 2010-2016
<a href="http://www.eclipse.org/">The Eclipse Foundation</a>.
All Rights Reserved.
</div>
<p id="poweredBy" class="pull-right">
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</p>
</div>
</footer>
</body>
</html>