Fork me on GitHub
Built by Maven

buildx:build

Full name:

org.honton.chas:buildx-maven-plugin:0.0.10:build

Description:

Create a container image from the Containerfile directions and files from context

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
<context> String - Directory containing source content for build
Default value is: ${project.build.directory}/context.
User property is: buildx.context.
<image> String - Fully qualified image name containing registry prefix, repository name, and version
User property is: buildx.image.

Optional Parameters

Name Type Since Description
<buildArguments> Map<String,String> - Map of build arguments
<builder> String - The name of an existing builder to use
Default value is: buildx-maven.
User property is: buildx.builder.
<cli> String - image build command line interface
Default value is: docker.
User property is: buildx.cli.
<containerFile> String - Build instruction file, relative to context
User property is: buildx.containerFile.
<contexts> Map<String,String> - Map of context name to location
<load> boolean - Load resulting image into local image cache
Default value is: true.
User property is: buildx.load.
<platforms> List<String> - The os/arch of the built image
User property is: buildx.platforms.
<provenance> String - Include provenance attestation. Acceptable values are "min", "max", "false"
User property is: buildx.provenance.
<registries> List<String> - For building/pushing to multiple registries. When used, do not include registry prefix in image value
User property is: buildx.registries.
<sbom> boolean - Include software bill of materials attestation.
Default value is: false.
User property is: buildx.sbom.
<skip> boolean - Skip upgrade
Default value is: false.
User property is: buildx.skip.

Parameter Details

<buildArguments>

Map of build arguments
  • Type: Map<String, String>
  • Required: No

<builder>

The name of an existing builder to use
  • Type: String
  • Required: No
  • User Property: buildx.builder
  • Default: buildx-maven

<cli>

image build command line interface
  • Type: String
  • Required: No
  • User Property: buildx.cli
  • Default: docker

<containerFile>

Build instruction file, relative to context
  • Type: String
  • Required: No
  • User Property: buildx.containerFile

<context>

Directory containing source content for build
  • Type: String
  • Required: Yes
  • User Property: buildx.context
  • Default: ${project.build.directory}/context

<contexts>

Map of context name to location
  • Type: Map<String, String>
  • Required: No

<image>

Fully qualified image name containing registry prefix, repository name, and version
  • Type: String
  • Required: Yes
  • User Property: buildx.image

<load>

Load resulting image into local image cache
  • Type: boolean
  • Required: No
  • User Property: buildx.load
  • Default: true

<platforms>

The os/arch of the built image
  • Type: List<String>
  • Required: No
  • User Property: buildx.platforms

<provenance>

Include provenance attestation. Acceptable values are "min", "max", "false"
  • Type: String
  • Required: No
  • User Property: buildx.provenance

<registries>

For building/pushing to multiple registries. When used, do not include registry prefix in image value
  • Type: List<String>
  • Required: No
  • User Property: buildx.registries

<sbom>

Include software bill of materials attestation.
  • Type: boolean
  • Required: No
  • User Property: buildx.sbom
  • Default: false

<skip>

Skip upgrade
  • Type: boolean
  • Required: No
  • User Property: buildx.skip
  • Default: false