Skip to content

Commit

Permalink
Site checkin for project Bonita Project Maven Plugin Parent
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 31, 2023
1 parent d9c41c8 commit b3b1fb0
Show file tree
Hide file tree
Showing 29 changed files with 1,299 additions and 2,154 deletions.
231 changes: 63 additions & 168 deletions analyze-mojo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/analyze-mojo.xml at 2023-10-19
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.10.1:report at 2023-10-31
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
Expand Down Expand Up @@ -30,8 +30,8 @@

<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2023-10-19</li>
<li id="projectVersion" class="pull-right">Version: 1.0.0-beta-02</li>
<li id="publishDate">Last Published: 2023-10-31</li>
<li id="projectVersion" class="pull-right">Version: 1.0.0</li>
<li class="pull-right"><span class="divider">|</span>
<a href="https://documentation.bonitasoft.com/" class="externalLink" title="Bonitasoft Documentation">Bonitasoft Documentation</a></li>
<li class="pull-right"><a href="https://www.bonitasoft.com/" class="externalLink" title="Bonitasoft">Bonitasoft</a></li>
Expand Down Expand Up @@ -74,215 +74,110 @@
</div>
</header>
<main id="bodyColumn" class="span10" >


<section>
<h2><a name="bonita-project:analyze"></a>bonita-project:analyze</h2>

<p><b>Full name</b>:</p>

<p>org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0-beta-02:analyze</p>

<p><b>Description</b>:</p>

<div>This mojo runs an analysis on the current project dependencies to detect Bonita specific extensions.</div>

<p><b>Attributes</b>:</p>

<section>
<h2><a name="bonita-project:analyze"></a>bonita-project:analyze</h2><a name="bonita-project:analyze"></a>
<p><strong>Full name</strong>:</p>
<p>org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:analyze</p>
<p><strong>Description</strong>:</p>
<p>This mojo runs an analysis on the current project dependencies to detect Bonita specific extensions.</p>
<p><strong>Attributes</strong>:</p>
<ul>

<li>Requires a Maven project to be executed.</li>

<li>Executes as an aggregator goal.</li>

<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li>
</ul>
<section>
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>

<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li></ul><section>
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a>
<table border="0" class="table table-striped">

<tr class="a">

<th>Name</th>

<th>Type</th>

<th>Since</th>

<th>Description</th>
</tr>

<th>Description</th></tr>
<tr class="b">

<td align="left"><code><a href="#excludeScope">&lt;excludeScope&gt;</a></code></td>

<td align="left"><a href="#excludeScope"><code>&lt;excludeScope&gt;</code></a></td>
<td><code>String</code></td>

<td><code>0.1.0</code></td>

<td>Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
<br />
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:

<ul>

<li><code>runtime</code> exclude scope excludes runtime and compile dependencies,</li>

<li><code>compile</code> exclude scope excludes compile, provided, and system dependencies,</li>

<li><code>test</code> exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile</li>

<li><code>provided</code> exclude scope just excludes provided dependencies,</li>

<li><code>system</code> exclude scope just excludes system dependencies.</li>
</ul><br /><b>User property is</b>: <code>excludeScope</code>.<br /></td>
</tr>

<li><code>runtime</code> exclude scope excludes runtime and compile dependencies,</li>
<li><code>compile</code> exclude scope excludes compile, provided, and system dependencies,</li>
<li><code>test</code> exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile</li>
<li><code>provided</code> exclude scope just excludes provided dependencies,</li>
<li><code>system</code> exclude scope just excludes system dependencies.</li>
</ul><br /><strong>User Property</strong>: <code>excludeScope</code></td></tr>
<tr class="a">

<td align="left"><code><a href="#includeScope">&lt;includeScope&gt;</a></code></td>

<td align="left"><a href="#includeScope"><code>&lt;includeScope&gt;</code></a></td>
<td><code>String</code></td>

<td><code>0.1.0</code></td>

<td>Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
<br />
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:

<ul>

<li><code>runtime</code> include scope gives runtime and compile dependencies,</li>

<li><code>compile</code> include scope gives compile, provided, and system dependencies,</li>

<li><code>test</code> include scope gives all dependencies (equivalent to default),</li>

<li><code>provided</code> include scope just gives provided dependencies,</li>

<li><code>system</code> include scope just gives system dependencies.</li>
</ul><br /><b>Default value is</b>: <code>runtime</code>.<br /><b>User property is</b>: <code>includeScope</code>.<br /></td>
</tr>

<li><code>runtime</code> include scope gives runtime and compile dependencies,</li>
<li><code>compile</code> include scope gives compile, provided, and system dependencies,</li>
<li><code>test</code> include scope gives all dependencies (equivalent to default),</li>
<li><code>provided</code> include scope just gives provided dependencies,</li>
<li><code>system</code> include scope just gives system dependencies.</li>
</ul><br /><strong>Default</strong>: <code>runtime</code><br /><strong>User Property</strong>: <code>includeScope</code></td></tr>
<tr class="b">

<td align="left"><code><a href="#outputFile">&lt;outputFile&gt;</a></code></td>

<td align="left"><a href="#outputFile"><code>&lt;outputFile&gt;</code></a></td>
<td><code>File</code></td>

<td><code>-</code></td>

<td>Analysis report output file.<br /><b>Default value is</b>: <code>${project.build.directory}/bonita-dependencies.json</code>.<br /><b>User property is</b>: <code>bonita.analyze.outputFile</code>.<br /></td>
</tr>

<td>Analysis report output file.<br /><strong>Default</strong>: <code>${project.build.directory}/bonita-dependencies.json</code><br /><strong>User Property</strong>: <code>bonita.analyze.outputFile</code></td></tr>
<tr class="a">

<td align="left"><code><a href="#validateDeps">&lt;validateDeps&gt;</a></code></td>

<td align="left"><a href="#validateDeps"><code>&lt;validateDeps&gt;</code></a></td>
<td><code>boolean</code></td>

<td><code>-</code></td>

<td>Look for incompatible dependencies.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>bonita.validateDependencies</code>.<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3CexcludeScope.3E"></a><b><a name="excludeScope">&lt;excludeScope&gt;</a></b></h4>

<td>Look for incompatible dependencies.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>bonita.validateDependencies</code></td></tr></table></section><section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="excludeScope"><section>
<h4><a name="a.3CexcludeScope.3E"></a>&lt;excludeScope&gt;</h4><a name="a.3CexcludeScope.3E"></a></a>
<div>Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
<br />
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:

<ul>

<li><code>runtime</code> exclude scope excludes runtime and compile dependencies,</li>

<li><code>compile</code> exclude scope excludes compile, provided, and system dependencies,</li>

<li><code>test</code> exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile</li>

<li><code>provided</code> exclude scope just excludes provided dependencies,</li>

<li><code>system</code> exclude scope just excludes system dependencies.</li>
<li><code>runtime</code> exclude scope excludes runtime and compile dependencies,</li>
<li><code>compile</code> exclude scope excludes compile, provided, and system dependencies,</li>
<li><code>test</code> exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile</li>
<li><code>provided</code> exclude scope just excludes provided dependencies,</li>
<li><code>system</code> exclude scope just excludes system dependencies.</li>
</ul></div>

<ul>

<li><b>Type</b>: <code>java.lang.String</code></li>

<li><b>Since</b>: <code>0.1.0</code></li>

<li><b>Required</b>: <code>No</code></li>

<li><b>User Property</b>: <code>excludeScope</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeScope.3E"></a><b><a name="includeScope">&lt;includeScope&gt;</a></b></h4>

<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>0.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>User Property</strong>: <code>excludeScope</code></li></ul><hr /></section><a name="includeScope"><section>
<h4><a name="a.3CincludeScope.3E"></a>&lt;includeScope&gt;</h4><a name="a.3CincludeScope.3E"></a></a>
<div>Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
<br />
The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary:

<ul>

<li><code>runtime</code> include scope gives runtime and compile dependencies,</li>

<li><code>compile</code> include scope gives compile, provided, and system dependencies,</li>

<li><code>test</code> include scope gives all dependencies (equivalent to default),</li>

<li><code>provided</code> include scope just gives provided dependencies,</li>

<li><code>system</code> include scope just gives system dependencies.</li>
<li><code>runtime</code> include scope gives runtime and compile dependencies,</li>
<li><code>compile</code> include scope gives compile, provided, and system dependencies,</li>
<li><code>test</code> include scope gives all dependencies (equivalent to default),</li>
<li><code>provided</code> include scope just gives provided dependencies,</li>
<li><code>system</code> include scope just gives system dependencies.</li>
</ul></div>

<ul>

<li><b>Type</b>: <code>java.lang.String</code></li>

<li><b>Since</b>: <code>0.1.0</code></li>

<li><b>Required</b>: <code>No</code></li>

<li><b>User Property</b>: <code>includeScope</code></li>

<li><b>Default</b>: <code>runtime</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CoutputFile.3E"></a><b><a name="outputFile">&lt;outputFile&gt;</a></b></h4>

<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>0.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>User Property</strong>: <code>includeScope</code></li>
<li><strong>Default</strong>: <code>runtime</code></li></ul><hr /></section><a name="outputFile"><section>
<h4><a name="a.3CoutputFile.3E"></a>&lt;outputFile&gt;</h4><a name="a.3CoutputFile.3E"></a></a>
<div>Analysis report output file.</div>

<ul>

<li><b>Type</b>: <code>java.io.File</code></li>

<li><b>Required</b>: <code>No</code></li>

<li><b>User Property</b>: <code>bonita.analyze.outputFile</code></li>

<li><b>Default</b>: <code>${project.build.directory}/bonita-dependencies.json</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CvalidateDeps.3E"></a><b><a name="validateDeps">&lt;validateDeps&gt;</a></b></h4>

<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>User Property</strong>: <code>bonita.analyze.outputFile</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}/bonita-dependencies.json</code></li></ul><hr /></section><a name="validateDeps"><section>
<h4><a name="a.3CvalidateDeps.3E"></a>&lt;validateDeps&gt;</h4><a name="a.3CvalidateDeps.3E"></a></a>
<div>Look for incompatible dependencies.</div>

<ul>

<li><b>Type</b>: <code>boolean</code></li>

<li><b>Required</b>: <code>No</code></li>

<li><b>User Property</b>: <code>bonita.validateDependencies</code></li>

<li><b>Default</b>: <code>true</code></li>
</ul>
</section></section>
</section>


<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>User Property</strong>: <code>bonita.validateDependencies</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul></section></section></section>
</main>
</div>
</div>
Expand Down
Loading

0 comments on commit b3b1fb0

Please sign in to comment.