Dockerfile (gradle-docker-plugin 6.7.0 API)

com.bmuschko.gradle.docker.tasks.image.Dockerfile

Creates a Dockerfile based on the provided instructions.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Dockerfile.AddFileInstruction`	Represents a `ADD` instruction.
`static class`	`Dockerfile.ArgInstruction`	Represents a `ARG` instruction.
`static class`	`Dockerfile.CommentInstruction`	Represents a comment instruction.
`static class`	`Dockerfile.CopyFile`	Input data for a CopyFileInstruction.
`static class`	`Dockerfile.CopyFileInstruction`	Represents a `COPY` instruction.
`static class`	`Dockerfile.DefaultCommandInstruction`	Represents a `CMD` instruction.
`static class`	`Dockerfile.EntryPointInstruction`	Represents a `ENTRYPOINT` instruction.
`static class`	`Dockerfile.EnvironmentVariableInstruction`	Represents a `ENV` instruction.
`static class`	`Dockerfile.ExposePortInstruction`	Represents a `EXPOSE` instruction.
`static class`	`Dockerfile.File`	Input data for a AddFileInstruction or CopyFileInstruction.
`static class`	`Dockerfile.FileInstruction`	An instruction whose value is a File.
`static class`	`Dockerfile.From`	Input data for a FromInstruction.
`static class`	`Dockerfile.FromInstruction`	Represents a `FROM` instruction.
`static class`	`Dockerfile.GenericInstruction`	An instruction that uses the provided value as-is without any additional formatting.
`static interface`	`Dockerfile.Instruction`	A representation of an instruction in a Dockerfile.
`static class`	`Dockerfile.LabelInstruction`	Represents a `LABEL` instruction.
`static class`	`Dockerfile.MapInstruction`	An instruction whose value is a Map.
`static class`	`Dockerfile.OnBuildInstruction`	Represents a `ONBUILD` instruction.
`static class`	`Dockerfile.RunCommandInstruction`	Represents a `RUN` instruction.
`static class`	`Dockerfile.StringArrayInstruction`	An instruction whose value is a String array.
`static class`	`Dockerfile.StringCommandInstruction`	An instruction whose value is a String.
`static class`	`Dockerfile.UserInstruction`	Represents a `USER` instruction.
`static class`	`Dockerfile.VolumeInstruction`
`static class`	`Dockerfile.WorkDirInstruction`	Represents a `WORKDIR` instruction.

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`
`class AbstractTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`RegularFileProperty`	`destFile` The destination file representing the Dockerfile.

Constructor Summary

Constructors
Constructor and description
`Dockerfile ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addFile(String src, String dest)` The ADD instruction copies new files, directories or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
	`void`	`addFile(File file)` The ADD instruction copies new files, directories or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
	`void`	`addFile(Provider<Dockerfile.File> provider)` A ADD instruction as Provider.
	`void`	`arg(String arg)` The ARG instruction defines a variable that users can pass at build-time to the builder.
	`void`	`arg(Provider<String> provider)` A ARG instruction as Provider.
	`void`	`copyFile(String src, String dest)` The COPY instruction copies new files or directories from <src> and adds them to the filesystem of the container at the path <dest>.
	`void`	`copyFile(Dockerfile.CopyFile file)` The COPY instruction copies new files or directories from <src> and adds them to the filesystem of the container at the path <dest>.
	`void`	`copyFile(Provider<Dockerfile.CopyFile> provider)` A COPY instruction as Provider.
	`void`	`create()`
	`void`	`defaultCommand(String... command)` The main purpose of a CMD instruction is to provide defaults for an executing container.
	`void`	`defaultCommand(Provider<List<String>> provider)` A CMD instruction as Provider.
	`void`	`entryPoint(String... entryPoint)` An ENTRYPOINT allows you to configure a container that will run as an executable.
	`void`	`entryPoint(Provider<List<String>> provider)` A ENTRYPOINT as Provider.
	`void`	`environmentVariable(String key, String value)` The ENV instruction sets the environment variable <key> to the value <value>.
	`void`	`environmentVariable(Map<String, String> envVars)` A ENV instruction as Map.
	`void`	`environmentVariable(Provider<Map<String, String>> provider)` A ENV instruction as Provider.
	`void`	`exposePort(Integer... ports)` The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
	`void`	`exposePort(Provider<List<Integer>> provider)` A EXPOSE instruction as Provider.
	`void`	`from(String image)` The FROM instruction sets the Base Image for subsequent instructions.
	`void`	`from(Dockerfile.From from)` The FROM instruction sets the Base Image for subsequent instructions.
	`void`	`from(Provider<Dockerfile.From> provider)` A FROM instruction as Provider.
	`Provider<Directory>`	`getDestDir()` Returns a provider representing the destination directory containing the Dockerfile.
	`ListProperty<Instruction>`	`getInstructions()` Returns all instructions used to generate the Dockerfile.
	`void`	`instruction(String instruction)` Adds a full instruction as String.
	`void`	`instruction(Provider<String> provider)` Adds a full instruction as Provider.
	`void`	`instructionsFromTemplate(File template)` Adds instructions to the Dockerfile from a template file.
	`void`	`instructionsFromTemplate(String templatePath)` Adds instructions to the Dockerfile from a template file.
	`void`	`instructionsFromTemplate(Provider<RegularFile> provider)` Adds instructions to the Dockerfile from a template file.
	`void`	`label(Map<String, String> labels)` The LABEL instruction adds metadata to an image.
	`void`	`label(Provider<Map<String, String>> provider)` A LABEL instruction as Provider.
	`void`	`onBuild(String instruction)` The ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build.
	`void`	`onBuild(Provider<String> provider)` A ONBUILD instruction as Provider.
	`void`	`runCommand(String command)` The RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
	`void`	`runCommand(Provider<String> provider)` A RUN instruction as Provider.
	`void`	`user(String user)` The USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
	`void`	`user(Provider<String> provider)` A USER instruction as Provider.
	`void`	`volume(String... volume)` The VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers.
	`void`	`volume(Provider<List<String>> provider)` A VOLUME instruction as Provider.
	`void`	`workingDir(String dir)` The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
	`void`	`workingDir(Provider<String> provider)` A WORKDIR instruction as Provider.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class AbstractTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - @OutputFile final RegularFileProperty destFile
    
    The destination file representing the Dockerfile. The destination file encourages the conventional file name Dockerfile but allows any arbitrary file name.
    Defaults to $buildDir/docker/Dockerfile.
    The method getDestDir() returns the parent directory of the Dockerfile.
- Constructor Detail
  - Dockerfile()
- Method Detail
  - void addFile(String src, String dest)
    
    The ADD instruction copies new files, directories or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     addFile('test', '/absoluteDir/')
 }
 
```
    Parameters:
    src - The source path
    dest - The destination path
    See Also:
    addFile(File)
    addFile(Provider)
  - void addFile(File file)
    
    The ADD instruction copies new files, directories or remote file URLs from <src> and adds them to the filesystem of the container at the path <dest>.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     addFile(new Dockerfile.File('test', '/absoluteDir/'))
 }
 
```
    Parameters:
    file - File definition
    See Also:
    addFile(String, String)
    addFile(Provider)
  - void addFile(Provider<Dockerfile.File> provider)
    
    A ADD instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     addFile(project.provider(new Callable() {
         @Override
         Dockerfile.File call() throws Exception {
             new Dockerfile.File('test', '/absoluteDir/')
         }
     }))
 }
 
```
    Parameters:
    provider - Add instruction as Provider
    See Also:
    addFile(String, String)
    addFile(File)
    Since:
    4.0.0
  - void arg(String arg)
    
    The ARG instruction defines a variable that users can pass at build-time to the builder.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     arg('user1=someuser')
 }
 
```
    Parameters:
    arg - Argument to pass, possibly with default value.
    See Also:
    arg(Provider)
  - void arg(Provider<String> provider)
    
    A ARG instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     arg(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             'user1=someuser'
         }
     }))
 }
 
```
    Parameters:
    provider - Argument to pass as Provider
    See Also:
    arg(String)
    Since:
    4.0.0
  - void copyFile(String src, String dest)
    
    The COPY instruction copies new files or directories from <src> and adds them to the filesystem of the container at the path <dest>.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     copyFile('test', '/absoluteDir/')
 }
 
```
    Parameters:
    src - The source path
    dest - The destination path
    See Also:
    copyFile(CopyFile)
    copyFile(Provider)
  - void copyFile(Dockerfile.CopyFile file)
    
    The COPY instruction copies new files or directories from <src> and adds them to the filesystem of the container at the path <dest>.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     copyFile(new Dockerfile.CopyFile('test', '/absoluteDir/'))
 }
 
```
    Parameters:
    file - File definition
    See Also:
    copyFile(String, String)
    copyFile(Provider)
  - void copyFile(Provider<Dockerfile.CopyFile> provider)
    
    A COPY instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     copyFile(project.provider(new Callable() {
         @Override
         Dockerfile.CopyFile call() throws Exception {
             new Dockerfile.CopyFile('test', '/absoluteDir/')
         }
     }))
 }
 
```
    Parameters:
    provider - Copy instruction as Provider
    See Also:
    copyFile(String, String)
    copyFile(CopyFile)
    Since:
    4.0.0
  - @TaskAction void create()
  - void defaultCommand(String... command)
    
    The main purpose of a CMD instruction is to provide defaults for an executing container.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     defaultCommand('/usr/bin/wc', '--help')
 }
 
```
    Parameters:
    command - Command
    See Also:
    defaultCommand(Provider)
  - void defaultCommand(Provider<List<String>> provider)
    
    A CMD instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     defaultCommand(project.provider(new Callable>() {
         @Override
         List call() throws Exception {
             ['/usr/bin/wc', '--help']
         }
     }))
 }
 
```
    Parameters:
    provider - Command as Provider
    See Also:
    defaultCommand(String...)
    Since:
    4.0.0
  - void entryPoint(String... entryPoint)
    
    An ENTRYPOINT allows you to configure a container that will run as an executable.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     entryPoint('top', '-b')
 }
 
```
    Parameters:
    entryPoint - Entry point
    See Also:
    entryPoint(Provider)
  - void entryPoint(Provider<List<String>> provider)
    
    A ENTRYPOINT as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     entryPoint(project.provider(new Callable>() {
         @Override
         List call() throws Exception {
             ['top', '-b']
         }
     }))
 }
 
```
    Parameters:
    entryPoint - Entry point
    See Also:
    entryPoint(String...)
    Since:
    4.0.0
  - void environmentVariable(String key, String value)
    
    The ENV instruction sets the environment variable <key> to the value <value>. This value will be passed to all future RUN instructions.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     environmentVariable('myName', 'John Doe')
 }
 
```
    Parameters:
    key - Key
    value - Value
    See Also:
    environmentVariable(Map)
    environmentVariable(Provider)
  - void environmentVariable(Map<String, String> envVars)
    
    A ENV instruction as Map.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     environmentVariable(['myName': 'John Doe'])
 }
 
```
    Parameters:
    envVars - Environment variables
    See Also:
    environmentVariable(String, String)
    environmentVariable(Provider)
  - void environmentVariable(Provider<Map<String, String>> provider)
    
    A ENV instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     environmentVariable(project.provider(new Callable>() {
         @Override
         Map call() throws Exception {
             ['myName': 'John Doe']
         }
     }))
 }
 
```
    Parameters:
    provider - Environment variables as Provider
    See Also:
    environmentVariable(String, String)
    environmentVariable(Map)
    Since:
    4.0.0
  - void exposePort(Integer... ports)
    
    The EXPOSE instruction informs Docker that the container will listen on the specified network ports at runtime.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     exposePort(8080, 9090)
 }
 
```
    Parameters:
    ports - Ports
    See Also:
    exposePort(Provider)
  - void exposePort(Provider<List<Integer>> provider)
    
    A EXPOSE instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     exposePort(project.provider(new Callable>() {
         @Override
         List call() throws Exception {
             [8080, 9090]
         }
     }))
 }
 
```
    Parameters:
    ports - Ports as Provider
    See Also:
    exposePort(Integer...)
    Since:
    4.0.0
  - void from(String image)
    
    The FROM instruction sets the Base Image for subsequent instructions.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     from('ubuntu:14.04')
 }
 
```
    Parameters:
    from - From definition
    See Also:
    from(From)
    from(Provider)
  - void from(Dockerfile.From from)
    
    The FROM instruction sets the Base Image for subsequent instructions.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     from(new From('ubuntu:14.04'))
 }
 
```
    Parameters:
    from - From definition
    stageName - stage name in case of multi-stage builds (default null)
    See Also:
    from(String)
    from(Provider)
  - void from(Provider<Dockerfile.From> provider)
    
    A FROM instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     from(project.provider(new Callable() {
         @Override
         Dockerfile.From call() throws Exception {
             new Dockerfile.From('ubuntu:14.04')
         }
     }))
 }
 
```
    Parameters:
    provider - From information as Provider
    See Also:
    from(From)
    Since:
    4.0.0
  - @Internal Provider<Directory> getDestDir()
    
    Returns a provider representing the destination directory containing the Dockerfile.
    Returns:
    The destination directory containing the Dockerfile
    Since:
    4.4.0
  - @Nested ListProperty<Instruction> getInstructions()
    
    Returns all instructions used to generate the Dockerfile.
    Returns:
    All instructions
  - void instruction(String instruction)
    
    Adds a full instruction as String.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     instruction('FROM ubuntu:14.04')
     instruction('LABEL maintainer=benjamin.muschko@gmail.com')
 }
 
```
    Parameters:
    instruction - Instruction as String
    See Also:
    instruction(Provider)
  - void instruction(Provider<String> provider)
    
    Adds a full instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     instruction(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             'FROM ubuntu:14.04'
         }
     }))
 }
 
```
    Parameters:
    provider - Instruction as Provider
    See Also:
    instruction(String)
    Since:
    4.0.0
  - void instructionsFromTemplate(File template)
    
    Adds instructions to the Dockerfile from a template file. The template file can have any name.
    Parameters:
    template - The template file
    See Also:
    instructionsFromTemplate(String)
    instructionsFromTemplate(Provider)
  - void instructionsFromTemplate(String templatePath)
    
    Adds instructions to the Dockerfile from a template file. The path can be relative to the project root directory or absolute.
    Parameters:
    templatePath - The path to the template file
    See Also:
    instructionsFromTemplate(java.io.File)
    instructionsFromTemplate(Provider)
  - void instructionsFromTemplate(Provider<RegularFile> provider)
    
    Adds instructions to the Dockerfile from a template file. Currently, the provider is evaluated as soon as the method is called which means that the provider is not evaluated lazily. This behavior might change in the future.
    Parameters:
    provider - The provider of the template file
    See Also:
    instructionsFromTemplate(java.io.File)
    instructionsFromTemplate(String)
    Since:
    4.0.0
  - void label(Map<String, String> labels)
    
    The LABEL instruction adds metadata to an image.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     label(['version': '1.0'])
 }
 
```
    Parameters:
    labels - Labels
    See Also:
    label(Provider)
  - void label(Provider<Map<String, String>> provider)
    
    A LABEL instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     label(project.provider(new Callable>() {
         @Override
         Map call() throws Exception {
             ['version': '1.0']
         }
     }))
 }
 
```
    Parameters:
    provider - Labels as Provider
    See Also:
    label(Map)
    Since:
    4.0.0
  - void onBuild(String instruction)
    
    The ONBUILD instruction adds to the image a trigger instruction to be executed at a later time, when the image is used as the base for another build.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     onBuild('ADD . /app/src')
 }
 
```
    Parameters:
    instruction - Instruction
    See Also:
    onBuild(Provider)
  - void onBuild(Provider<String> provider)
    
    A ONBUILD instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     onBuild(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             'ADD . /app/src'
         }
     }))
 }
 
```
    Parameters:
    instruction - Instruction
    See Also:
    onBuild(String)
    Since:
    4.0.0
  - void runCommand(String command)
    
    The RUN instruction will execute any commands in a new layer on top of the current image and commit the results.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     runCommand('/bin/bash -c echo hello')
 }
 
```
    Parameters:
    command - Command
    See Also:
    runCommand(Provider)
  - void runCommand(Provider<String> provider)
    
    A RUN instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     runCommand(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             '/bin/bash -c echo hello'
         }
     }))
 }
 
```
    Parameters:
    provider - Command as Provider
    See Also:
    runCommand(String)
    Since:
    4.0.0
  - void user(String user)
    
    The USER instruction sets the user name or UID to use when running the image and for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     user('patrick')
 }
 
```
    Parameters:
    user - User
    See Also:
    user(Provider)
  - void user(Provider<String> provider)
    
    A USER instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     user(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             'patrick'
         }
     }))
 }
 
```
    Parameters:
    provider - User as Provider
    See Also:
    user(String)
    Since:
    4.0.0
  - void volume(String... volume)
    
    The VOLUME instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     volume('/myvol')
 }
 
```
    Parameters:
    volume - Volume
    See Also:
    volume(Provider)
  - void volume(Provider<List<String>> provider)
    
    A VOLUME instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     volume(project.provider(new Callable>() {
         @Override
         List call() throws Exception {
             ['/myvol']
         }
     }))
 }
 
```
    Parameters:
    volume - Volume
    See Also:
    volume(String...)
    Since:
    4.0.0
  - void workingDir(String dir)
    
    The WORKDIR instruction sets the working directory for any RUN, CMD and ENTRYPOINT instructions that follow it in the Dockerfile.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     workingDir('/path/to/workdir')
 }
 
```
    Parameters:
    dir - Directory
    See Also:
    workingDir(Provider)
  - void workingDir(Provider<String> provider)
    
    A WORKDIR instruction as Provider.
    Example in Groovy DSL:
```
 task createDockerfile(type: Dockerfile) {
     workingDir(project.provider(new Callable() {
         @Override
         String call() throws Exception {
             '/path/to/workdir'
         }
     }))
 }
 
```
    Parameters:
    dir - Directory
    See Also:
    workingDir(String)
    Since:
    4.0.0

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Dockerfile

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@OutputFile final RegularFileProperty destFile

Constructor Detail

Dockerfile()

Method Detail

void addFile(String src, String dest)

void addFile(File file)

void addFile(Provider<Dockerfile.File> provider)

void arg(String arg)

void arg(Provider<String> provider)

void copyFile(String src, String dest)

void copyFile(Dockerfile.CopyFile file)

void copyFile(Provider<Dockerfile.CopyFile> provider)

@TaskAction void create()

void defaultCommand(String... command)

void defaultCommand(Provider<List<String>> provider)

void entryPoint(String... entryPoint)

void entryPoint(Provider<List<String>> provider)

void environmentVariable(String key, String value)

void environmentVariable(Map<String, String> envVars)

void environmentVariable(Provider<Map<String, String>> provider)

void exposePort(Integer... ports)

void exposePort(Provider<List<Integer>> provider)

void from(String image)

void from(Dockerfile.From from)

void from(Provider<Dockerfile.From> provider)

@Internal Provider<Directory> getDestDir()

@Nested ListProperty<Instruction> getInstructions()

void instruction(String instruction)

void instruction(Provider<String> provider)

void instructionsFromTemplate(File template)

void instructionsFromTemplate(String templatePath)

void instructionsFromTemplate(Provider<RegularFile> provider)

void label(Map<String, String> labels)

void label(Provider<Map<String, String>> provider)

void onBuild(String instruction)

void onBuild(Provider<String> provider)

void runCommand(String command)

void runCommand(Provider<String> provider)

void user(String user)

void user(Provider<String> provider)

void volume(String... volume)

void volume(Provider<List<String>> provider)

void workingDir(String dir)

void workingDir(Provider<String> provider)