blob: c379623f976d680ecb7eaccd805f912871c70e21 [file] [log] [blame]
<!DOCTYPE html>
<html class="no-js" lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Apache NetBeans Maven Utilities - NBM Maven Plugin &#x2013; Maven 2 NBM Plugin</title>
<link rel="stylesheet" href="./css/netbeans.css" />
<link href="https://fonts.googleapis.com/css?family=Lato:400,700" rel="stylesheet">
</head>
<body>
<div class="top-bar" id="responsive-menu">
<div class='top-bar-left'>
<a class='title' href="http://netbeans.apache.org"><img src='/images/apache-netbeans.svg' style='padding: 8px; height: 48px;'>Apache NetBeans (incubating)</a>
</div>
<div class="top-bar-right">
<ul class="vertical medium-horizontal menu" style="right: 90px;" data-responsive-menu="drilldown medium-dropdown">
<li> <a href="../nb-repository/index.html">NB Repository Plugin</a> </li>
<li> <strong style='line-height: 1;margin-bottom: 0;padding: 0.7rem 1rem;display: block;' >NBM Plugin</strong> </li>
<li> <a href="../shared/index.html">Shared</a> </li>
<li> <a href="../parent/index.html">Parent</a> </li>
</ul>
</div>
</div>
<div class='grid-container main-content'>
<div id="toc" class="toc">
<div id="toctitle">Overview</div>
<ul class="sectlevel1">
<li><a href="index.html">Usage</a></li>
<li><a href="plugin-info.html">Plugin Goals</a></li>
</ul>
<div id="toctitle">HOWTOs</div>
<ul class="sectlevel1">
<li><a href="buildinstexample.html">Customize installers</a></li>
<li><a href="upgrade.html">Upgrade from older versions</a></li>
</ul>
<div id="toctitle">Deprecated</div>
<ul class="sectlevel1">
<li><a href="nbm.html">Descriptor Format</a></li>
<li><a href="descriptor.html">Example Descriptor</a></li>
</ul>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="section">
<h2><a name="Example_nbm_descriptors_-_since_3.8_DEPRECATED."></a>Example nbm descriptors - since 3.8 DEPRECATED.</h2>
<p>These descriptors are referenced from the <a href="./nbm-mojo.html">nbm:nbm</a> mojo. The descriptor file is deprecated since version 3.8.</p>
<div class="section">
<h3><a name="Usual_case"></a>Usual case</h3>
<p>A rather common module descriptor. Basic properties filled in, defines some libraries that ship with the module and declared dependencies on other NetBeans modules.</p>
<div class="source">
<pre>&lt;nbm&gt;
&lt;moduleType&gt;normal&lt;/moduleType&gt;
&lt;codeNameBase&gt;org.codehaus.mevenide.netbeans/2&lt;/codeNameBase&gt;
&lt;cluster&gt;mevenide&lt;/cluster&gt;
&lt;manifest&gt;src/main/nbm/manifest.mf&lt;/manifest&gt;
&lt;!-- distributionUrl important when creating an autoupdate center. The expected download URL for the module is:
${distributionUrl}/${finalName}.nbm
--&gt;
&lt;distributionUrl&gt;http://mevenide.codehaus.org/nbm_release2&lt;/distributionUrl&gt;
&lt;licenseName&gt;Apache License, Version 2.0&lt;/licenseName&gt;
&lt;licenseFile&gt;license.txt&lt;/licenseFile&gt;
&lt;libraries&gt;
&lt;!-- these dependencies get copied to modules/ext directory in the mevenide cluster and
get referenced from the module's jar usign the Class-Path manifest entry.
Not necessary since 2.5 version of nbm-maven-plugin
--&gt;
&lt;library&gt;org.netbeans.api:org-netbeans-graph&lt;/library&gt;
&lt;library&gt;org.netbeans.api:org-netbeans-graph-vmd&lt;/library&gt;
&lt;/libraries&gt;
&lt;dependencies&gt;
&lt;!-- all of these dependencies get referrenced as module dependencies of this project's artifact.
Not necessary since 2.5 version of nbm-maven-plugin
--&gt;
&lt;dependency&gt;
&lt;id&gt;org.codehaus.mevenide:run-jar-bridge&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.codehaus.mevenide:debugger-bridge&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.netbeans.api:org-netbeans-api-debugger-jpda&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.netbeans.api:org-netbeans-api-debugger&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.netbeans.api:org-netbeans-modules-options-api&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.netbeans.api:org-openide-io&lt;/id&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;id&gt;org.netbeans.api:org-openide-modules&lt;/id&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
&lt;/nbm&gt;</pre></div></div>
<div class="section">
<h3><a name="Additional_custom_files_in_module"></a>Additional custom files in module</h3>
<p>Apart from the usual properties, this one declares additional files that ought to be packed into the module.</p>
<div class="source">
<pre>&lt;nbm&gt;
&lt;moduleType&gt;eager&lt;/moduleType&gt;
&lt;codeNameBase&gt;org.codehaus.mevenide.netbeans.nbrepo/2&lt;/codeNameBase&gt;
&lt;cluster&gt;mevenide&lt;/cluster&gt;
&lt;manifest&gt;src/main/nbm/manifest.mf&lt;/manifest&gt;
&lt;distributionUrl&gt;http://mevenide.codehaus.org/nbm_release2&lt;/distributionUrl&gt;
&lt;licenseName&gt;Apache License, Version 2.0&lt;/licenseName&gt;
&lt;licenseFile&gt;license.txt&lt;/licenseFile&gt;
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;id&gt;org.codehaus.mevenide:nb-project&lt;/id&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
&lt;nbmResources&gt;
&lt;nbmResource&gt;
&lt;baseDirectory&gt;../ide-mojos/target&lt;/baseDirectory&gt;
&lt;includes&gt;
&lt;include&gt;m2-repository/**&lt;/include&gt;
&lt;/includes&gt;
&lt;/nbmResource&gt;
&lt;/nbmResources&gt;
&lt;/nbm&gt;</pre></div></div></div>
</div>
</div>
</div>
<div class='grid-container incubator-area' style='margin-top: 64px'>
<div class='grid-x grid-padding-x'>
<div class='large-auto cell text-center'>
<a href="https://www.apache.org/">
<img style="width: 320px" title="Apache Software Foundation" src="/images/asf_logo_wide.svg" />
</a>
</div>
<div class='large-auto cell text-center'>
<a href="https://www.apache.org/events/current-event.html">
<img style="width:234px; height: 60px;" title="Apache Software Foundation current event" src="https://www.apache.org/events/current-event-234x60.png"/>
</a>
</div>
</div>
</div>
<div class='footer-disclaimer'>
<div class="footer-disclaimer-content">
<p>Copyright &copy; 2017-2018 <a href="https://www.apache.org">The Apache Software Foundation</a>.</p>
<p>Licensed under the Apache <a href="https://www.apache.org/licenses/">license</a>, version 2.0</p>
<p><a href="https://incubator.apache.org/" alt="Apache Incubator"><img src='/images/incubator_feather_egg_logo_bw_crop.png' title='Apache Incubator'></img></a></p>
<div style='max-width: 40em; margin: 0 auto'>
<p>Apache NetBeans is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
<p>Apache Incubator, Apache, the Apache feather logo, the Apache NetBeans logo, and the Apache Incubator project logo are trademarks of <a href="https://www.apache.org">The Apache Software Foundation</a>.</p>
<p>Oracle and Java are registered trademarks of Oracle and/or its affiliates.</p>
</div>
</div>
</div>
<a href="https://github.com/apache/incubator-netbeans-mavenutils"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png" alt="Fork me on GitHub"></a>
<script src="/js/vendor/jquery-3.2.1.min.js"></script>
<script src="/js/vendor/what-input.js"></script>
<script src="/js/vendor/jquery.colorbox-min.js"></script>
<script src="/js/vendor/foundation.min.js"></script>
<script src="/js/netbeans.js"></script>
<script>
$(function(){ $(document).foundation(); });
</script>
</body>