step.yml

title: |-
  Docker Build & Push
summary: |
  Building and pushing docker images with built-in cache support
description: |
  Enables you to build and optionally push docker images with built-in Bitrise key-value cache support.
  It is possible to customize the docker build command to utilize other cache mechanisms, such as registry-cache.
website: https://github.com/bitrise-steplib/bitrise-step-docker-build-push
source_code_url: https://github.com/bitrise-steplib/bitrise-step-docker-build-push
support_url: https://github.com/bitrise-steplib/bitrise-step-docker-build-push/issues

type_tags:
- build

toolkit:
  go:
    package_name: github.com/bitrise-steplib/bitrise-step-docker-build-push

inputs:
- tags:
  opts:
    title: Image tags
    summary: List of tags (full image names) to be applied to the built image
    description: |-
      List of tags (full image names) to be applied to the built image

      Add one tag per line. Example: `myregistry.com/myimage:latest`
    is_required: true

- context: .
  opts:
    title: Build context path
    summary: Path to the build context to be used for the docker build
    description: |-
      Path to the build context to be used for the docker build

      The path is relative to the working directory.
    is_required: true

- file: ./Dockerfile
  opts:
    title: Dockerfile path
    summary: Path to the Dockerfile to be built
    description: |-
      Path to the Dockerfile to be built

      The path is relative to the working directory.
    is_required: true

- push: "false"
  opts:
    title: Push docker image
    summary: When set to 'true', the docker image will be pushed
    description: |-
      When set to 'true', the docker image will be pushed.
    value_options:
    - "true"
    - "false"
    is_required: true

- use_bitrise_cache: "false"
  opts:
    title: Use Bitrise key-value cache
    summary: When set to 'true', image will be cached automatically with Bitrise key-value cache
    description: |-
      When set to 'true', the docker image will automatically be cached using Bitrise key-value cache.

      The following cache keys will be used:
      - docker-imagename-{{ .OS }}-{{ .Arch }}-{{ .Branch }}-{{ .CommitHash }}
      - docker-imagename-{{ .OS }}-{{ .Arch }}-{{ .Branch }}
      - docker-imagename-{{ .OS }}-{{ .Arch }}

      Warning: Do not specify the cache-to and cache-from parameters when using this option.
    value_options:
    - "true"
    - "false"
    is_required: true

- build_arg:
  opts:
    title: Build arguments
    summary: List of [build arguments](https://docs.docker.com/build/guide/build-args/) to be passed to the docker build
    description: |-
      List of build arguments to be passed to the docker build

      Add one build argument per line. Example: `MY_BUILD_ARG=myvalue`
    is_required: false

- cache_from:
  opts:
    title: Cache from arguments
    summary: List of arguments to be passed to the docker build for cache-from
    description: |-
      List of arguments to be passed to the docker build for cache-from

      Add one cache-from argument per line. Example: `type=registry,ref=myregistry.dev/myrepository/my-image:latest`
    is_required: false

- cache_to:
  opts:
    title: Cache to arguments
    summary: List of arguments to be passed to the docker build for cache-to
    description: |-
      List of arguments to be passed to the docker build for cache-to

      Add one cache-to argument per line. Example: `type=registry,ref=myregistry.dev/myrepository/my-image:latest,mode=max,compression=zstd`
    is_required: false

- extra_options:
  opts:
    title: Extra options
    summary: List of extra options to be passed to the docker build
    description: |-
      List of extra options to be passed to the docker build

      Extra options must be in the format of `--option value` or `--option=value`.

      Warning:
        When using values with quotes in them (for example when they contain spaces) do not use the equal sign.
        Separate it with spaces instead. Example: `--option "value with spaces"`

      Add one extra option per line.
    is_required: false

- buildx_host_network: "false"
  opts:
    title: Enables to use the host network with the buildkit build container
    summary: Enables to use the host network with the buildkit build container
    is_required: true
    value_options:
    - "true"
    - "false"

- verbose: "false"
  opts:
    title: Verbose logging
    summary: Enable logging additional information for troubleshooting
    is_required: true
    value_options:
    - "true"
    - "false"