@dotcom-tool-kit/docker NPM

@dotcom-tool-kit/docker

Installation & Usage

With Tool Kit already set up, install this plugin as a dev dependency:

npm install --save-dev @dotcom-tool-kit/docker

And add it to your repo's .toolkitrc.yml:

plugins:
  - '@dotcom-tool-kit/docker'

Tasks

`DockerBuild`

Task options

Property	Description	Type	Default
`ssh`	whether to forward host's SSH agent, see https://docs.docker.com/reference/cli/docker/buildx/build/#ssh	`boolean`	`false`

All properties are optional.

Plugin-wide options

`@dotcom-tool-kit/docker`

Property Type

images (*) Object with dynamic keys of type string and values of type Object with properties:definition: string - The path to the Dockerfile definition file for this imageplatform: string - The platform to target when building the Docker image, e.g. linux/arm64 or linux/amd64registry: string - The registry that the Docker image is pushed to, excluding name and tagname: string (regex: /^[a-z][a-z-]+$/) - The name of the image, excluding a tag

Property	Type
`images` (*)	Object with dynamic keys of type `string` and values of type Object with properties:`definition`: `string` - The path to the Dockerfile definition file for this image`platform`: `string` - The platform to target when building the Docker image, e.g. linux/arm64 or linux/amd64`registry`: `string` - The registry that the Docker image is pushed to, excluding name and tag`name`: `string` (regex: `/^[a-z][a-z-]+$/`) - The name of the image, excluding a tag