Built by Maven

toolbox:flatten-bom

Full name:

eu.maveniverse.maven.plugins:toolbox:0.15.0:flatten-bom

Description:

Flattens a BOM and attaches it.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<attach> boolean - Whether to attach to project the flattened BOM or not.
Default: false
User Property: attach
<bom> String - The GAV of BOM to flatten.
User Property: bom
<outputFile> File - The output file.
Default: ${project.build.directory}/flatten-bom.xml
User Property: outputFile

Optional Parameters

Name Type Since Description
<dryRun> boolean - Option to run potentially destructive commands without performing any IO.
Default: false
User Property: dryRun
<extraRepositories> String - Appends extra repositories to context.
User Property: extraRepositories
<failOnLogicalFailure> boolean - Makes command fail on "logical" failure.
Default: true
User Property: failOnLogicalFailure
<forceStdout> boolean - No description.
User Property: forceStdout
<gav> String - The GAV to emit flattened BOM with.
Default: ${project.groupId}:${project.artifactId}:${project.version}
User Property: gav
<repositoryVendor> String - The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
User Property: toolbox.search.backend.type
<verbosity> Output$Verbosity - No description.
Default: NORMAL
User Property: verbosity

Parameter Details

<attach>

Whether to attach to project the flattened BOM or not.
  • Type: boolean
  • Required: Yes
  • User Property: attach
  • Default: false

<bom>

The GAV of BOM to flatten.
  • Type: java.lang.String
  • Required: Yes
  • User Property: bom

<dryRun>

Option to run potentially destructive commands without performing any IO.
  • Type: boolean
  • Required: No
  • User Property: dryRun
  • Default: false

<extraRepositories>

Appends extra repositories to context.
  • Type: java.lang.String
  • Required: No
  • User Property: extraRepositories

<failOnLogicalFailure>

Makes command fail on "logical" failure.
  • Type: boolean
  • Required: No
  • User Property: failOnLogicalFailure
  • Default: true

<forceStdout>

No description.
  • Type: boolean
  • Required: No
  • User Property: forceStdout

<gav>

The GAV to emit flattened BOM with.
  • Type: java.lang.String
  • Required: No
  • User Property: gav
  • Default: ${project.groupId}:${project.artifactId}:${project.version}

<outputFile>

The output file.
  • Type: java.io.File
  • Required: Yes
  • User Property: outputFile
  • Default: ${project.build.directory}/flatten-bom.xml

<repositoryVendor>

The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
  • Type: java.lang.String
  • Required: No
  • User Property: toolbox.search.backend.type

<verbosity>

No description.
  • Type: eu.maveniverse.maven.toolbox.shared.output.Output$Verbosity
  • Required: No
  • User Property: verbosity
  • Default: NORMAL