Using containers in Bitrise Workflows

This example shows a simple use of the container property to enable Steps or groups of Steps to use different execution environments.

We test our application using two different versions of Node.js, using the public node images from Docker Hub. We also run a custom Python script to validate our changes before testing them.

containers:
  node_22:
    image: node:22
  node_20:
    image: node:20
  python:
    image: python:3.12

workflows:
  ci:
    steps:
    - git-clone@8: {}
    - with:
        container: python
        steps:
        - script:
            title: Validate our changes using a custom python script
              inputs:
              - content: python3 validate.py
    - with:
        container: node_22
          steps:
          - script:
              title: NPM install
              inputs:
              - content: npm ci
          - script:
              title: NPM test
              inputs:
              - content: npm test
    - with:
        container: node_20
          steps:
          - script:
              title: NPM install
              inputs:
              - content: npm ci
          - script:
              title: NPM test
              inputs:
              - content: npm test 

When the ci Workflow is running:

containers:
  node-21:
    image: node:21.6

services:
  postgres:
    image: postgres:16
    envs:
    - POSTGRES_USER: postgres
    - POSTGRES_DB: bitrise
    # You can reference Bitrise secrets here, e.g: $POSTGRES_PASSWORD
    - POSTGRES_PASSWORD: password
    ports:
    - 5432:5432
    options: >-
      --health-cmd pg_isready
      --health-interval 10s
      --health-timeout 5s
      --health-retries 5
  redis:
    image: redis:7
    ports:
    - 6379:6379
    options: >-
      --health-cmd "redis-cli ping"
      --health-interval 10s
      --health-timeout 5s
      --health-retries 5

workflows:
  e2e-tests:
    envs:
    - POSTGRES_DSN: "postgres://postgres:password@postgres:5432/bitrise"
    - REDIS_DSN: "redis://redis:6379/1"
    steps:
    - with:
        container: node-21
        services:
        - postgres
        - redis
        steps:
        - script:
            title: e2e tests
            inputs:
            - content: npm run e2e-tests

The example configuration defines a Workflow called e2e-tests.

This Workflow's with group uses service containers to enable a more advanced integration test scenario using postgres and redis. It also utilizes a container to run the tests in a Node environment.

There are two services defined: postgres and redis. Each service is configured to have healthchecks using the options parameter. The CLI will respect those options and only start the execution of the Steps once every service reports healthy.

Each service is exposed on a port, but as we are utilizing containers, they will be accessible using their name postgres:5432 and redis:6379, respectively.

Once the services are ready, the Step will execute the npm run e2e-tests command, which can utilize the environment variables POSTGRES_DSN and REDIS_DSN defined by the Workflow to connect to services.