Configuration

bit-ship.yml

is a configuration file that allows you to customize your Bit-Ship environment.

version

  • type: string
  • default: 1.0

The version of the configuration file. The current version is 1.0.

name

  • type: string
  • default: ''

Name of your project.

images

  • type: Image
  • default: {}

image section is generated based on the analysis of your app. It contains the Docker image that will be used to run your app. You can change the image to a different one if you want to use a different base image.

image.d.ts
// Names of supported tools https://www.bit-ship.dev/tools
import {ToolsNames} from "../shared";

export interface Image {
  name: string,
  dependencies?: {
    [key in ToolsNames]?: string
  }
}

tasks

  • type: Task
  • default: {}

The tasks section allows you to define reusable scripts.

Type definition:

task.d.ts
export interface Task {
  script: string,
  location?: string,
  env? : {
    [key: string]: string
  }
  volumes?: string[]
}

jobs

  • type: Job
  • default: {} Jobs are sequences of tasks that can be run manually or hooked to a triggers.

Type definition:

job.d.ts
export interface Job {
  on: {
    commit?: {
      on:  'pre-commit' | 'post-commit'
    },
  },
  tasks: Array<string | string[]>
}

apps

to be implemented

volumes

to be implemented

vaults

to be implemented