Build Docker Image with YAML
Tip
Learn more about:
- Build Docker Image action features
- Build Docker Image integrations
- Build Docker Image alternatives
YAML parameters for building Docker images
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to DOCKERFILE. |
dockerfile_path Required | String | The path of the desired dockerfile in the repository. Default is DOCKERFILE. |
| context_path | String | The docker build image context path. |
| docker_image_tag | String | The tag of the Docker image. |
| login | String | The username required to connect to the server. Required for delivering the Dockerfile to a private registry. |
| password | String | The password required to connect to the server. Required for delivering the Dockerfile to a private registry. |
| integration | String | The ID of the integration. Available values: NONE, DOCKER_HUB, AMAZON_ECR, GOOGLE_GCR, GOOGLE_ARTIFACT_REGISTRY, GIT_HUB_CONTAINER_REGISTRY, OTHER. |
| region | String | The name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here. |
| registry | String | The url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR. |
| repository | String | The location of the Docker repository. |
| build_args | String[] | The arguments used when building the image from the Dockerfile. |
| insecure_registry | Boolean | If set to true, ignore SSL errors upon connecting to the Docker registry. |
| do_not_prune_images | Boolean | If set to true, dangling images will not be pruned after the build. |
| buildkit | Boolean | The Docker BuildKit will be activated while invoking the docker build command. By default, it is set to true. |
| secrets | DockerBuildSecret[] | The list of secrets to be sent using the --secret parameter. |
| provenance | String | Refers to the --provenance switch of the Docker build. Available values: NONE, MIN, MAX. The default value is NONE. |
| cache_mode | String | Available if the dockerbuildcache in the pipeline where this action is located, is set to WORKSPACE or PROJECT. Defines the Docker cache mode. Available values are MIN or MAX. By default, it is set to MIN. |
| docker_registry | String | The type of registry you authorize to. Available values: NONE, DOCKER_HUB, AMAZON_ECR, GOOGLE_GCR, GOOGLE_ARTIFACT_REGISTRY, GIT_HUB_CONTAINER_REGISTRY, OTHER. It must be provided together with image_location. If not specified, the system will automatically set it based on other data from the action. |
YAML example for building Docker images
yamlactions: - action: "Build dockerfile" type: "DOCKERFILE" region: "us-east-1" integration: "my_integration" docker_image_tag: "14.06" dockerfile_path: "dir/Dockerfile" repository: "MyDockerRepo" build_args: - "key=value" insecure_registry: true do_not_prune_images: true secrets: - id: "someSecret" value: "path_to_secret" type: "FILE" - id: "mysecret" value: "MY_ENV_VAR_KEY" type: "ENV"
DockerBuildSecret Schema
Properties
| Name | Type | Description |
|---|---|---|
| id | String | The identifier to pass into the docker buildx --secret. This identifier is associated with the RUN --mount identifier to use in the Dockerfile. |
| value | String | If type=FILE, it is a path to the file in the filesystem. If type=ENV, it is the name of the variable whose value will be passed to the secret. |
| type | String | The type of the secret. Set FILE if you want to use a file from the filesystem. If you want it to be a variable value, choose ENV. |
Last modified on Aug 1, 2025