Property Detail

• @Input @Optional final MapProperty<String, String> buildArgs

  Build-time variables to pass to the image build.

• @Input @Optional final SetProperty<String> cacheFrom

  Images to consider as cache sources.

• @InputFile @PathSensitive(value: PathSensitivity.RELATIVE) @Optional final RegularFileProperty dockerFile

  The Dockerfile to use to build the image. If null, will use 'Dockerfile' in the build context, i.e. "$inputDir/Dockerfile".

• @Input @Optional final SetProperty<String> extraHosts

  Build-time additional host list to pass to the image build in the format host:ip.

  Since:

  6.2.0

• @Internal final Property<String> imageId

  The ID of the image built. The value of this property requires the task action to be executed.

• @OutputFile final RegularFileProperty imageIdFile

  Output file containing the image ID of the built image. Defaults to "$buildDir/.docker/$taskpath-imageId.txt". If path contains ':' it will be replaced by '_'.

  Since:

  4.9.0

• @Input @Optional final SetProperty<String> images

  The images including repository, image name and tag to be built e.g. vieux/apache:2.0.

  Since:

  6.0.0

• @InputDirectory @PathSensitive(value: PathSensitivity.RELATIVE) final DirectoryProperty inputDir

  Input directory containing the build context. Defaults to "$buildDir/docker".

• @Input @Optional MapProperty<String, String> labels

  Labels to attach as metadata for to the image.

  This property is not final to allow build authors to remove the labels from the up-to-date check by extending DockerBuildImage and annotating the overrided getLabels() method with @Internal, example:

   import com.bmuschko.gradle.docker.tasks.image.DockerBuildImage
  
   class CustomDockerBuildImage extends DockerBuildImage {
  Override:
  @Internal
       MapProperty getLabels() {
           super.getLabels()
       }
   }
   

  A use case for excluding the labels from the up-to-date check is if build author wants to set build information as labels (date, version-control-revision).

• @Input @Optional final Property<Long> memory

  Memory allocated for build specified in bytes (no suffix is needed)

  Since:

  7.3.0

• @Input @Optional final Property<String> network

  Networking mode for the RUN instructions during build.

• @Input @Optional final Property<Boolean> noCache

  When true, do not use docker cache when building the image.

• @Input @Optional final Property<String> platform

  The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.

  Since:

  7.1.0

• @Input @Optional final Property<Boolean> pull

  When true, always attempt to pull a newer version of the image.

• @Input @Optional final Property<Boolean> quiet

  When true, suppress the build output and print image ID on success.

• final DockerRegistryCredentials registryCredentials

  {@inheritDoc}

• @Input @Optional final Property<Boolean> remove

  When true, remove intermediate containers after a successful build.

• @Input @Optional final Property<Long> shmSize

  Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.

• @Input @Optional final Property<String> target

  With this parameter it is possible to build a special stage in a multi-stage Docker file.

  This feature is only available for use with Docker 17.05 and higher.

  Since:

  4.10.0

Constructor Detail

• DockerBuildImage()

Method Detail

• @Override void registryCredentials(Action<? super DockerRegistryCredentials> action)

  {@inheritDoc}

• @Override void runRemoteCommand()