Skip to content

Commit

Permalink
Deploying to gh-pages from @ 2d40108 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed May 30, 2024
1 parent acdab86 commit 6ccaf06
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 64 deletions.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ <h2><a name="Goals"></a>Goals</h2>
<li><code>makeAggregateBom</code>: creates an aggregate BOM at build root (with dependencies from the whole multi-modules build), and eventually a BOM for each module,</li>
<li><code>makePackageBom</code>: creates a BOM for each Maven module with <code>war</code> or <code>ear</code> packaging.</li>
</ul>
<p>By default, the BOM(s) will be attached as an additional artifacts with <code>cyclonedx</code> classifier and <code>xml</code> or <code>json</code> extension during a Maven <code>install</code> or <code>deploy</code>:</p>
<p>By default, the BOM(s) will be attached as an additional artifacts with <code>cyclonedx</code> classifier (can be customized by setting <code>cyclonedx.classifier</code>) and <code>xml</code> or <code>json</code> extension during a Maven <code>install</code> or <code>deploy</code>:</p>
<ul>

<li><code>${project.artifactId}-${project.version}-cyclonedx.xml</code></li>
Expand Down
61 changes: 37 additions & 24 deletions makeAggregateBom-mojo.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,31 +99,36 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_
<td><code>2.1.0</code></td>
<td>Specify the Maven project dependency analyzer to use (plexus component role-hint). By default, <a href="https://maven.apache.org/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a>'s one is used. To use another implementation, you must declare a dependency for this plugin that contains the code for the analyzer and you specify its Plexus role name here.<br /><strong>Default</strong>: <code>default</code><br /><strong>User Property</strong>: <code>analyzer</code></td></tr>
<tr class="a">
<td align="left"><a href="#classifier"><code>&lt;classifier&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.8.1</code></td>
<td>Classifier of the attached sbom<br /><strong>Default</strong>: <code>cyclonedx</code><br /><strong>User Property</strong>: <code>cyclonedx.classifier</code></td></tr>
<tr class="b">
<td align="left"><a href="#detectUnusedForOptionalScope"><code>&lt;detectUnusedForOptionalScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.7.9</code></td>
<td>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.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>detectUnusedForOptionalScope</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#excludeArtifactId"><code>&lt;excludeArtifactId&gt;</code></a></td>
<td><code>String[]</code></td>
<td><code>2.4.0</code></td>
<td>Excluded reactor project (aka module) ArtifactIds from aggregate BOM.<br /><strong>User Property</strong>: <code>excludeArtifactId</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#excludeGroupId"><code>&lt;excludeGroupId&gt;</code></a></td>
<td><code>String[]</code></td>
<td><code>2.7.3</code></td>
<td>Excluded reactor project (aka module) GroupIds from aggregate BOM.<br /><strong>User Property</strong>: <code>excludeGroupId</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#excludeTestProject"><code>&lt;excludeTestProject&gt;</code></a></td>
<td><code>Boolean</code></td>
<td><code>2.4.0</code></td>
<td>Should reactor project (aka module) artifactId with the word "test" be excluded from aggregate BOM?<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>excludeTestProject</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#excludeTypes"><code>&lt;excludeTypes&gt;</code></a></td>
<td><code>String[]</code></td>
<td><code>2.1.0</code></td>
<td>Excluded types.<br /><strong>User Property</strong>: <code>excludeTypes</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#externalReferences"><code>&lt;externalReferences&gt;</code></a></td>
<td><code>ExternalReference[]</code></td>
<td><code>2.7.11</code></td>
Expand All @@ -136,92 +141,92 @@ <h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_
&lt;/externalReference&gt;
&lt;/externalReferences&gt;
</pre><br /><strong>See also:</strong> <a href="https://cyclonedx.github.io/cyclonedx-core-java/org/cyclonedx/model/ExternalReference.Type.html">ExternalReference.Type constants</a></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#includeBomSerialNumber"><code>&lt;includeBomSerialNumber&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should the resulting BOM contain a unique serial number?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>includeBomSerialNumber</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#includeCompileScope"><code>&lt;includeCompileScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should compile scoped Maven dependencies be included in bom?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>includeCompileScope</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#includeLicenseText"><code>&lt;includeLicenseText&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should license text be included in bom?<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>includeLicenseText</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#includeProvidedScope"><code>&lt;includeProvidedScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should provided scoped Maven dependencies be included in bom?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>includeProvidedScope</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#includeRuntimeScope"><code>&lt;includeRuntimeScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should runtime scoped Maven dependencies be included in bom?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>includeRuntimeScope</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#includeSystemScope"><code>&lt;includeSystemScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should system scoped Maven dependencies be included in bom?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>includeSystemScope</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#includeTestScope"><code>&lt;includeTestScope&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Should test scoped Maven dependencies be included in bom?<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>includeTestScope</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#outputDirectory"><code>&lt;outputDirectory&gt;</code></a></td>
<td><code>File</code></td>
<td><code>2.7.5</code></td>
<td>The output directory where to store generated CycloneDX output files.<br /><strong>Default</strong>: <code>${project.build.directory}</code><br /><strong>User Property</strong>: <code>outputDirectory</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#outputFormat"><code>&lt;outputFormat&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.1.0</code></td>
<td>The CycloneDX output format that should be generated (<code>xml</code>, <code>json</code> or <code>all</code>).<br /><strong>Default</strong>: <code>all</code><br /><strong>User Property</strong>: <code>outputFormat</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#outputName"><code>&lt;outputName&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.2.0</code></td>
<td>The CycloneDX output file name (without extension) that should be generated (in <code>outputDirectory</code> directory).<br /><strong>Default</strong>: <code>bom</code><br /><strong>User Property</strong>: <code>outputName</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#outputReactorProjects"><code>&lt;outputReactorProjects&gt;</code></a></td>
<td><code>Boolean</code></td>
<td><code>2.6.2</code></td>
<td>Should non-root reactor projects create a module-only BOM?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>outputReactorProjects</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#outputTimestamp"><code>&lt;outputTimestamp&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.7.9</code></td>
<td>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>).<br /><strong>Default</strong>: <code>${project.build.outputTimestamp}</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#projectType"><code>&lt;projectType&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.0.0</code></td>
<td>The component type associated to the SBOM metadata. See <a href="https://cyclonedx.org/docs/1.5/json/#metadata_component_type">CycloneDX reference</a> for supported values.<br /><strong>Default</strong>: <code>library</code><br /><strong>User Property</strong>: <code>projectType</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#schemaVersion"><code>&lt;schemaVersion&gt;</code></a></td>
<td><code>String</code></td>
<td><code>2.1.0</code></td>
<td>The CycloneDX schema version the BOM will comply with.<br /><strong>Default</strong>: <code>1.5</code><br /><strong>User Property</strong>: <code>schemaVersion</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#skip"><code>&lt;skip&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>1.1.3</code></td>
<td>Skip CycloneDX execution.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>cyclonedx.skip</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#skipAttach"><code>&lt;skipAttach&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.1.0</code></td>
<td>Don't attach bom.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>cyclonedx.skipAttach</code></td></tr>
<tr class="a">
<tr class="b">
<td align="left"><a href="#skipNotDeployed"><code>&lt;skipNotDeployed&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.7.11</code></td>
<td>Only runs this goal or adds to aggregate SBOM if the module does not skip deploy.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>cyclonedx.skipNotDeployed</code></td></tr>
<tr class="b">
<tr class="a">
<td align="left"><a href="#verbose"><code>&lt;verbose&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>2.6.0</code></td>
Expand All @@ -234,7 +239,15 @@ <h4><a name="a.3Canalyzer.3E"></a>&lt;analyzer&gt;</h4><a name="a.3Canalyzer.3E"
<li><strong>Since</strong>: <code>2.1.0</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"></a><section>
<li><strong>Default</strong>: <code>default</code></li></ul><hr /></section><a name="classifier"></a><section>
<h4><a name="a.3Cclassifier.3E"></a>&lt;classifier&gt;</h4><a name="a.3Cclassifier.3E"></a>
<div>Classifier of the attached sbom</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>2.8.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>cyclonedx.classifier</code></li>
<li><strong>Default</strong>: <code>cyclonedx</code></li></ul><hr /></section><a name="detectUnusedForOptionalScope"></a><section>
<h4><a name="a.3CdetectUnusedForOptionalScope.3E"></a>&lt;detectUnusedForOptionalScope&gt;</h4><a name="a.3CdetectUnusedForOptionalScope.3E"></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>
Expand Down
Loading

0 comments on commit 6ccaf06

Please sign in to comment.