Knowledge

Build Application

Parameters
Name Description
action Required String The ID of the action.
type Required String The type of the action. Should be set to BUILD.
docker_image_name Required String The name of the Docker image.
docker_image_tag Required String The tag of the Docker image.
execute_commands Required String[] The commands that will be executed.
trigger_time String Specifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
cached_dirs String[] The dependencies & directories to be cached and available to every execution in this pipeline.
working_directory String The directory in which the pipeline filesystem will be mounted.
setup_commands String[] The command that will be executed only on the first run.
shell String The name of the shell that will be used to execute commands. Can be one of SH or BASH (default).
services Service[] The containers with the services that will be attached to this environment. Available types: MYSQL, MONGO_DB, MARIADB, POSTGRE_SQL, REDIS, MEMCACHED, ELASTICSEARCH.
login String The username required to connect to the Dockerhub, private registry or GCR.
password String The password required to connect to the Dockerhub, private registry or GCR.
registry String The url to the Docker registry or GCR.
integration_id Integration The integration. Required for using the image from the Amazon ECR.
region String The name of the Amazon S3 region. Required for using the image from the Amazon ECR. The full list of regions is available here.
trigger_condition String Defines when the build action should be run. Can be one of ALWAYS, ON_CHANGE or ON_CHANGE_AT_PATH.
trigger_condition_paths String[] Required when trigger_condition is set to ON_CHANGE_AT_PATH.
Example
actions:
  - action: "Build application"
    type: "BUILD"
    docker_image_name: "library/ubuntu"
    docker_image_tag: "latest"
    execute_commands:
    - "ls -al > ls.log"
    setup_commands:
    - "apt-get update -y"
    - "apt-get install -y wget"
    services:
    - type: "MYSQL"
      version: "5.7"
    - type: "MONGO_DB"
      version: "3.2.4"
    cached_dirs:
    - "/build/test"
    - "/bin/Debug"
    trigger_condition: "ON_CHANGE_AT_PATH"
    trigger_condition_paths: 
    - "/src"
    - "/tests"
    working_directory: "/buddy/my-repo-dir"
    shell: "SH"
Example
Using private image from Dockerhub
actions:
  - action: "Build application"
    type: "BUILD"
    docker_image_name: "buddyworks/private_image"
    docker_image_tag: "latest"
    execute_commands:
    - "ls -al > ls.log"
	login: "buddyworks"
	password: "${top_secret_password}"
Example
Using image from private registry
actions:
  - action: "Build application"
    type: "BUILD"
    docker_image_name: "buddyworks/private_image"
    docker_image_tag: "latest"
    execute_commands:
    - "ls -al > ls.log"
	login: "buddyworks"
	password: "${top_secret_password}"
    registry: "my.registry.com"
Example
Using image from Google Container Registry
actions:
  - action: "Build application"
    type: "BUILD"
    docker_image_name: "tokyo-house-147623/private_image"
    docker_image_tag: "latest"
    execute_commands:
    - "ls -al > ls.log"
	login: "_json_key"
	password: "${google_json_key}"
    registry: "my.gcr.com"
Example
Using image from Amazon ECR
actions:
  - action: "Build application"
    type: "BUILD"
    docker_image_name: "private_image"
    docker_image_tag: "latest"
    execute_commands:
    - "ls -al > ls.log"
    region: "us-east-1"
    integration_id: 1

Get started now

14 days of unlimited trial. No credit card required.