Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 1.82 KB

deploy.md

File metadata and controls

83 lines (66 loc) · 1.82 KB
Raw

Deploy Config

All keys from the Common Config are valid in addition to the keys documented here.

deploymentKey

Specify to deploy to a Deployment specified in deploymentMap.

deploy:
  deploymentKey: dev

deployTargetKey

Specify to deploy to a DeployTarget.

deploy:
  deployTargetKey: dev01

deploymentMap

  • environmentKey: environment to deploy to
  • event: primary event to pull image tags from
  • eventRegex: regular expression matching events
  • eventFallback: fallback event to pull image tags from
  • imageOverrides: list of images to override for this deployment, see "imageOverrides" below for format
  • trigger: if true, deployment will be automatically triggered when a matching image event occurs
  • triggerBranch: when paired with trigger: true, overrides defaultBranch as the deployment branch
deploy:
  defaultBranch: develop
  deploymentMap:
    dev:
      environmentKey: dev
      event: commit/master
      trigger: true
    feature:
      environmentKey: dev
      eventRegex: commit/feature-(.*)
      trigger: true
      triggerBranch: feature
    stage:
      environmentKey: dev
      event: tag/rc
      imageOverrides:
      - path: test/b
        event: commit/develop
        eventFallback: commit/develop2
      trigger: true
    prod:
      environmentKey: prod
      event: tag/release
      trigger: false

environmentKey

Specify to deploy to an environment.

deploy:
  environmentKey: dev

imageOverrides

List of images to override for every deployment

  • path: image path
  • event: primary event to pull image tags from
  • eventFallback: fallback event to pull image tags from
deploy:
  imageOverrides:
    - path: test/b
      event: commit/develop
      eventFallback: commit/master