Using your own Docker image

In this example, we’re following the official getting started guide to run the hello-world Docker image. In our example bitrise.yml file, you can see a simple build configuration that can run the image:

---
format_version: 11
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
trigger_map:
- push_branch: "*"
  workflow: primary
- pull_request_source_branch: "*"
  workflow: primary
workflows:
  primary:
    steps:
    - activate-ssh-key@4:
        run_if: ''
    - [email protected]: {}
    - script@1:
        title: docker run hello-world
        inputs:
        - content: |-
            #!/bin/bash
            # fail if any commands fails
            set -e
            # debug log
            set -x

            docker login -u $DOCKERHUB_USER -p $DOCKERHUB_TOKEN
            docker run hello-world

You can use your own Dockerfile on Bitrise in your repository to define the Docker environment:

---
format_version: 11
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
trigger_map:
- push_branch: "*"
  workflow: primary
- pull_request_source_branch: "*"
  workflow: primary
workflows:
  primary:
    steps:
    - activate-ssh-key@4:
        run_if: ''
    - [email protected]: {}
    - script@1:
        title: docker run
        inputs:
        - content: |-
            #!/bin/bash
            # fail if any commands fails
            set -e
            # debug log
            set -x

            docker build -t bitrise-minimal-sample .
            docker run --rm bitrise-minimal-sample

This Workflow will:

If you have a Dockerfile like this in the root of the repository:

FROM alpine:3.3

CMD cat /etc/alpine-release

The output will look something like this:

+------------------------------------------------------------------------------+
| (2) docker run hello-world                                                   |
+------------------------------------------------------------------------------+
| id: script                                                                   |
| version: 1.1.3                                                               |
| collection: https://github.com/bitrise-io/bitrise-steplib.git                |
| toolkit: bash                                                                |
| time: 2016-11-21T14:28:23Z                                                   |
+------------------------------------------------------------------------------+
|                                                                              |
+ docker build -t bitrise-minimal-sample .
Sending build context to Docker daemon 69.12 kB

Step 1 : FROM alpine:3.3
3.3: Pulling from library/alpine
985c5f84712b: Pulling fs layer
985c5f84712b: Verifying Checksum
985c5f84712b: Download complete
985c5f84712b: Pull complete
Digest: sha256:ec40755933414575748cecf929f1f2012cace2d2e0f8147e77e652d600ff17d7
Status: Downloaded newer image for alpine:3.3
 ---> 6c2aa2137d97
Step 2 : CMD cat /etc/alpine-release
 ---> Running in 507cfb961cc7
 ---> 02a0da3ac697
Removing intermediate container 507cfb961cc7
Successfully built 02a0da3ac697
+ docker run --rm bitrise-minimal-sample
3.3.3
|                                                                              |
+---+---------------------------------------------------------------+----------+
| ✓ | docker run hello-world                                        | 4.24 sec |
+---+---------------------------------------------------------------+----------+

You can also run a Docker image from your own Docker file using the docker-compose command. With compose, you can configure your application’s services and then you can start all services with a single command.

For example, set up a docker-compose.yml like this in your repository root (where the Dockerfile is):

version: '2'
services:
  sample-app:
    build: .

Now you can run your services with a single docker-compose call in your Script Step:

- [email protected]:
    title: docker run
    inputs:
    - content: |-
        #!/bin/bash
        # fail if any commands fails
        set -e
        # debug log
        set -x
        docker-compose run --rm sample-app

Docker compose will build and run the image automatically. You don’t have to specify a -t tag since the services name will be used by docker-compose to tag the image automatically.

We have four different Docker image types available. You can base your own image on any of these, depending on your needs.

To base your own image on one of our available images, specify your base image at the very top of your Dockerfile with a FROM instruction and the quay.io ID of the image. In our example, we’ll use the latest version of the Bitrise base image:

FROM quay.io/bitriseio/docker-bitrise-base:latest

You have to use the quay.io ID of the image you want to use as the base image. For example, quay.io/bitriseio/android, quay.io/bitriseio/android-ndk, quay.io/bitriseio/android-ndk-lts, or quay.io/bitriseio/bitrise-base.

You can set your own Docker image in the Workflow Editor if the image can be pulled with the docker pull command and you use the Ubuntu 20.04 stack.

Now you should be able to use your own image to run your builds on bitrise.io.