Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4d71b50 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed Jan 14, 2024
1 parent 99049bb commit dca33ee
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 69 deletions.
50 changes: 25 additions & 25 deletions makeAggregateBom-mojo.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.10.2:report at 2024-01-14
| Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.11.0:report at 2024-01-14
| Rendered using Apache Maven Fluido Skin 1.10.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
Expand Down Expand Up @@ -217,185 +217,185 @@ <h4><a name="a.3Canalyzer.3E"></a>&lt;analyzer&gt;</h4><a name="a.3Canalyzer.3E"
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>analyzer</code></li>
<li><strong>Default</strong>: <code>default</code></li></ul><hr /></section><a name="detectUnusedForOptionalScope"><section>
<h4><a name="a.3CdetectUnusedForOptionalScope.3E"></a>&lt;detectUnusedForOptionalScope&gt;</h4><a name="a.3CdetectUnusedForOptionalScope.3E"></a></a>
<div>Use the original mechanism for determining whether a component has OPTIONAL or REQUIRED scope, relying on bytecode analysis of the compiled classes instead of the Maven dependency declaration of optional.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.7.9</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>detectUnusedForOptionalScope</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="excludeArtifactId"><section>
<h4><a name="a.3CexcludeArtifactId.3E"></a>&lt;excludeArtifactId&gt;</h4><a name="a.3CexcludeArtifactId.3E"></a></a>
<div>Excluded reactor project (aka module) ArtifactIds from aggregate BOM.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Since</strong>: <code>2.4.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>excludeArtifactId</code></li></ul><hr /></section><a name="excludeGroupId"><section>
<h4><a name="a.3CexcludeGroupId.3E"></a>&lt;excludeGroupId&gt;</h4><a name="a.3CexcludeGroupId.3E"></a></a>
<div>Excluded reactor project (aka module) GroupIds from aggregate BOM.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Since</strong>: <code>2.7.3</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>excludeGroupId</code></li></ul><hr /></section><a name="excludeTestProject"><section>
<h4><a name="a.3CexcludeTestProject.3E"></a>&lt;excludeTestProject&gt;</h4><a name="a.3CexcludeTestProject.3E"></a></a>
<div>Should reactor project (aka module) artifactId with the word "test" be excluded from aggregate BOM?</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.Boolean</code></li>
<li><strong>Since</strong>: <code>2.4.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>excludeTestProject</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="excludeTypes"><section>
<h4><a name="a.3CexcludeTypes.3E"></a>&lt;excludeTypes&gt;</h4><a name="a.3CexcludeTypes.3E"></a></a>
<div>Excluded types.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>excludeTypes</code></li></ul><hr /></section><a name="includeBomSerialNumber"><section>
<h4><a name="a.3CincludeBomSerialNumber.3E"></a>&lt;includeBomSerialNumber&gt;</h4><a name="a.3CincludeBomSerialNumber.3E"></a></a>
<div>Should the resulting BOM contain a unique serial number?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeBomSerialNumber</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeCompileScope"><section>
<h4><a name="a.3CincludeCompileScope.3E"></a>&lt;includeCompileScope&gt;</h4><a name="a.3CincludeCompileScope.3E"></a></a>
<div>Should compile scoped Maven dependencies be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeCompileScope</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeLicenseText"><section>
<h4><a name="a.3CincludeLicenseText.3E"></a>&lt;includeLicenseText&gt;</h4><a name="a.3CincludeLicenseText.3E"></a></a>
<div>Should license text be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeLicenseText</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="includeProvidedScope"><section>
<h4><a name="a.3CincludeProvidedScope.3E"></a>&lt;includeProvidedScope&gt;</h4><a name="a.3CincludeProvidedScope.3E"></a></a>
<div>Should provided scoped Maven dependencies be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeProvidedScope</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeRuntimeScope"><section>
<h4><a name="a.3CincludeRuntimeScope.3E"></a>&lt;includeRuntimeScope&gt;</h4><a name="a.3CincludeRuntimeScope.3E"></a></a>
<div>Should runtime scoped Maven dependencies be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeRuntimeScope</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeSystemScope"><section>
<h4><a name="a.3CincludeSystemScope.3E"></a>&lt;includeSystemScope&gt;</h4><a name="a.3CincludeSystemScope.3E"></a></a>
<div>Should system scoped Maven dependencies be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeSystemScope</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="includeTestScope"><section>
<h4><a name="a.3CincludeTestScope.3E"></a>&lt;includeTestScope&gt;</h4><a name="a.3CincludeTestScope.3E"></a></a>
<div>Should test scoped Maven dependencies be included in bom?</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>includeTestScope</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="outputDirectory"><section>
<h4><a name="a.3CoutputDirectory.3E"></a>&lt;outputDirectory&gt;</h4><a name="a.3CoutputDirectory.3E"></a></a>
<div>The output directory where to store generated CycloneDX output files.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>2.7.5</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>outputDirectory</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}</code></li></ul><hr /></section><a name="outputFormat"><section>
<h4><a name="a.3CoutputFormat.3E"></a>&lt;outputFormat&gt;</h4><a name="a.3CoutputFormat.3E"></a></a>
<div>The CycloneDX output format that should be generated (<code>xml</code>, <code>json</code> or <code>all</code>).</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>outputFormat</code></li>
<li><strong>Default</strong>: <code>all</code></li></ul><hr /></section><a name="outputName"><section>
<h4><a name="a.3CoutputName.3E"></a>&lt;outputName&gt;</h4><a name="a.3CoutputName.3E"></a></a>
<div>The CycloneDX output file name (without extension) that should be generated (in <code>outputDirectory</code> directory).</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.2.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>outputName</code></li>
<li><strong>Default</strong>: <code>bom</code></li></ul><hr /></section><a name="outputReactorProjects"><section>
<h4><a name="a.3CoutputReactorProjects.3E"></a>&lt;outputReactorProjects&gt;</h4><a name="a.3CoutputReactorProjects.3E"></a></a>
<div>Should non-root reactor projects create a module-only BOM?</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.Boolean</code></li>
<li><strong>Since</strong>: <code>2.6.2</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>outputReactorProjects</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="outputTimestamp"><section>
<h4><a name="a.3CoutputTimestamp.3E"></a>&lt;outputTimestamp&gt;</h4><a name="a.3CoutputTimestamp.3E"></a></a>
<div>Timestamp for reproducible output archive entries, either formatted as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int representing seconds since the epoch (like <a href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.7.9</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>${project.build.outputTimestamp}</code></li></ul><hr /></section><a name="projectType"><section>
<h4><a name="a.3CprojectType.3E"></a>&lt;projectType&gt;</h4><a name="a.3CprojectType.3E"></a></a>
<div>The component type associated to the SBOM metadata. See <a href="https://cyclonedx.org/docs/1.4/json/#metadata_component_type">CycloneDX reference</a> for supported values.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>projectType</code></li>
<li><strong>Default</strong>: <code>library</code></li></ul><hr /></section><a name="schemaVersion"><section>
<h4><a name="a.3CschemaVersion.3E"></a>&lt;schemaVersion&gt;</h4><a name="a.3CschemaVersion.3E"></a></a>
<div>The CycloneDX schema version the BOM will comply with.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>schemaVersion</code></li>
<li><strong>Default</strong>: <code>1.4</code></li></ul><hr /></section><a name="skip"><section>
<h4><a name="a.3Cskip.3E"></a>&lt;skip&gt;</h4><a name="a.3Cskip.3E"></a></a>
<div>Skip CycloneDX execution.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cyclonedx.skip</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="skipAttach"><section>
<h4><a name="a.3CskipAttach.3E"></a>&lt;skipAttach&gt;</h4><a name="a.3CskipAttach.3E"></a></a>
<div>Don't attach bom.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.1.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cyclonedx.skipAttach</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="skipNotDeployed"><section>
<h4><a name="a.3CskipNotDeployed.3E"></a>&lt;skipNotDeployed&gt;</h4><a name="a.3CskipNotDeployed.3E"></a></a>
<div>Only runs this goal or adds to aggregate SBOM if the module does not skip deploy.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.7.11</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cyclonedx.skipNotDeployed</code></li>
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="verbose"><section>
<h4><a name="a.3Cverbose.3E"></a>&lt;verbose&gt;</h4><a name="a.3Cverbose.3E"></a></a>
<div>Verbose output.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>2.6.0</code></li>
<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cyclonedx.verbose</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul></section></section></section>
</main>
Expand Down
Loading

0 comments on commit dca33ee

Please sign in to comment.