Skip to content

Commit

Permalink
Deploying to gh-pages from @ 22e0b8e 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@goneall
goneall committed Jan 28, 2025
1 parent 92edcf4 commit b3d5bc9
Show file tree
Hide file tree
Showing 15 changed files with 310 additions and 60 deletions.
159 changes: 142 additions & 17 deletions aggregateSPDX-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/aggregateSPDX-mojo.xml at 2025-01-25
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/aggregateSPDX-mojo.xml at 2025-01-28
| Rendered using Apache Maven Fluido Skin 1.11.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
Expand Down Expand Up @@ -33,7 +33,7 @@
<li class=""><a href="../" title="GH">GH</a><span class="divider">/</span></li>
<li class=""><a href="./" title="SPDX Maven Plugin">SPDX Maven Plugin</a><span class="divider">/</span></li>
<li class="active ">spdx:aggregateSPDX</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2025-01-25</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2025-01-28</li>
<li id="projectVersion" class="pull-right">Version: 0.7.5-SNAPSHOT</li>
</ul>
</div>
Expand Down Expand Up @@ -324,6 +324,61 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>

<tr class="a">

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

<td><code>boolean</code></td>

<td><code>0.8.0</code></td>

<td>If true, include compile scope in dependency graph<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="b">

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

<td><code>boolean</code></td>

<td><code>0.8.0</code></td>

<td>If true, include provided scope in dependency graph<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="a">

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

<td><code>boolean</code></td>

<td><code>0.8.0</code></td>

<td>If true, include runtime scope in dependency graph<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="b">

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

<td><code>boolean</code></td>

<td><code>0.8.0</code></td>

<td>If true, include system scope in dependency graph<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="a">

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

<td><code>boolean</code></td>

<td><code>0.8.0</code></td>

<td>If true, include test scope in dependency graph<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="b">

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

<td><code>boolean</code></td>
Expand All @@ -333,7 +388,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>If true, all transitive dependencies will be included in the SPDX document. If false, only direct dependencies will be included.<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -344,7 +399,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>This field provides a place for the SPDX file creator to record any general comments about the license.<br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -355,7 +410,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>This field contains the license the SPDX file creator has concluded as governing the package or alternative values, if the governing license cannot be determined. If this field is not specified, the declared license value will be used for the concluded license. The format of the string follows the standard license string format for SPDX files (see the defaultFileConcludedLicense parameter for a full description).<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -366,7 +421,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>License declared by the originator for the package. If no license is specified, the license information in the project POM file will be mapped to a standard SPDX license if available. If a non-standard license is used, a NOASSERTION value will be used. The format of the string follows the standard license string format for SPDX files (see the defaultFileConcludedLicense parameter for a full description).<br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -377,7 +432,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>Optional parameter if set to true will match a Maven license to an SPDX standard license if the Maven license URL matches any of the cross-reference license URLs for a standard license. Default value is true. Note: Several SPDX standard licenses contain the same cross-reference license URL. In this case, the SPDX standard license used in indeterminate.<br /><b>Default value is</b>: <code>true</code>.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand Down Expand Up @@ -405,7 +460,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
</pre></div><br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -416,7 +471,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>Configure whether only locally cached license list should be used. (a) If set to true, only locally cached version of license list is used. (b) otherwise, the license list is queried over the internet.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -429,7 +484,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<p>The default for this is the Maven organization</p><br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -440,7 +495,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>Output file format for the SPDX file. One of: - JSON - JSON SPDX format - RDF/XML - RDF/XML format<br /><b>Default value is</b>: <code>JSON</code>.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -465,7 +520,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
</pre></div><br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand Down Expand Up @@ -512,7 +567,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
</pre></div><br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -523,7 +578,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>Skip goal execution.<br /><b>User property is</b>: <code>spdx.skip</code>.<br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -534,7 +589,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>This field provides a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package. For example, this field might include comments indicating whether the package been was pulled from a source code management system or has been repackaged.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand All @@ -545,7 +600,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>Document namespace - must be unique for the artifact and SPDX file<br /><b>Default value is</b>: <code>http://spdx.org/spdxpackages/${project.groupId}_${project.artifactId}-${project.version}</code>.<br /></td>
</tr>

<tr class="a">
<tr class="b">

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

Expand All @@ -556,7 +611,7 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<td>SPDX File name<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}/${project.groupId}_${project.artifactId}-${project.version}.spdx</code>.<br /><b>User property is</b>: <code>spdxFileName</code>.<br /></td>
</tr>

<tr class="b">
<tr class="a">

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

Expand Down Expand Up @@ -786,6 +841,76 @@ <h4><a name="a.3CgeneratePurls.3E"></a><b><a name="generatePurls">&lt;generatePu

<li><b>User Property</b>: <code>spdx.generatePurls</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeCompileScope.3E"></a><b><a name="includeCompileScope">&lt;includeCompileScope&gt;</a></b></h4>

<div>If true, include compile scope in dependency graph</div>

<ul>

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

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

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

<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeProvidedScope.3E"></a><b><a name="includeProvidedScope">&lt;includeProvidedScope&gt;</a></b></h4>

<div>If true, include provided scope in dependency graph</div>

<ul>

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

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

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

<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeRuntimeScope.3E"></a><b><a name="includeRuntimeScope">&lt;includeRuntimeScope&gt;</a></b></h4>

<div>If true, include runtime scope in dependency graph</div>

<ul>

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

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

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

<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeSystemScope.3E"></a><b><a name="includeSystemScope">&lt;includeSystemScope&gt;</a></b></h4>

<div>If true, include system scope in dependency graph</div>

<ul>

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

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

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

<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeTestScope.3E"></a><b><a name="includeTestScope">&lt;includeTestScope&gt;</a></b></h4>

<div>If true, include test scope in dependency graph</div>

<ul>

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

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

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

<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CincludeTransitiveDependencies.3E"></a><b><a name="includeTransitiveDependencies">&lt;includeTransitiveDependencies&gt;</a></b></h4>

<div>If true, all transitive dependencies will be included in the SPDX document. If false, only direct dependencies will be included.</div>
Expand Down
Loading

0 comments on commit b3d5bc9

Please sign in to comment.