Spec

A Pipeline needs .version, .kind, and .metadata fields.

A Pipeline also needs a .spec section.

Examples

Basic Pipeline with implicit clone step (will checkout connected repo automatically)

version: '1.0'
kind: pipeline
metadata:
  name: codefresh-io/cli/default-pipeline
  labels:
    tags: []
  deprecate:
    applicationPort: '8080'
    repoPipeline: true
spec:
  triggers:
    - type: git
      repo: codefresh-io/cli
      events:
        - push.heads
      pullRequestAllowForkEvents: false
      commentRegex: /.*/gi
      branchRegex: /.*/gi
      branchRegexInput: regex
      provider: github
  contexts: []
  variables:
    - key: PORT
      value: '3000'
    - key: SECRET
      value: 'secret-value'
      encrypted: true
  steps:
    test_step_1:
      image: alpine
      working_directory: '${{clone_step}}'
      commands:
        - echo ls
        - echo "hello world"
        - echo "plain value $PORT"
        - echo "encrypted value $PAPA"
        - echo "value from context $COOKIE"
    build:
      type: build
      working_directory: '${{clone_step}}'
      dockerfile: ./Dockerfile
      image_name: my-custom-docker-image
      tag: foo
  stages: []

Basic Pipeline with explicit clone step

version: '1.0'
kind: pipeline
metadata:
  name: codefresh-io/cli/basic-pipeline
  labels:
    tags: []
  deprecate:
    applicationPort: '8080'
    repoPipeline: true
spec:
  triggers:
    - type: git
      repo: codefresh-io/cli
      events:
        - push.heads
      pullRequestAllowForkEvents: false
      commentRegex: /.*/gi
      branchRegex: /.*/gi
      branchRegexInput: regex
      provider: github
  contexts: []
  variables:
    - key: PORT
      value: '3000'
    - key: SECRET
      value: 'secret-value'
      encrypted: true
  steps:
    clone_step:
      repo: codefresh-contrib/python-flask-sample-app
      revision: master
      type: git-clone
      git: CF-default
    test_step_1:
      image: alpine
      working_directory: '${{clone_step}}'
      commands:
        - echo ls
        - echo "hello world"
        - echo "plain value $PORT"
        - echo "encrypted value $PAPA"
        - echo "value from context $COOKIE"
    build:
      type: build
      working_directory: '${{clone_step}}'
      dockerfile: ./Dockerfile
      image_name: my-custom-docker-image
      tag: bla
  stages: []

Pipeline with a remote spec template brought from a git repository

version: '1.0'
kind: pipeline
metadata:
  name: codefresh-io/cli/from-repo
  isPublic: false
  labels:
    tags: []
  deprecate:
    applicationPort: '8080'
    repoPipeline: true
spec:
  triggers:
    - type: git
      repo: codefresh-io/cli
      events:
        - push.heads
      pullRequestAllowForkEvents: false
      commentRegex: /.*/gi
      branchRegex: /.*/gi
      branchRegexInput: regex
      provider: github
  contexts: []
  variables:
    - key: PORT
      value: '3000'
    - key: SECRET
      value: 'secret-value'
      encrypted: true
  specTemplate:
    location: git
    context: git-context-name # if not specified will use the default git-context
    repo: codefresh-io/cli
    path: codefresh.yml
    revision: master # can be a branch or commit. if not specified will use CF_BRANCH variable value
  steps: {}
  stages: []

Pipeline with a remote spec template from a public git URL

version: '1.0'
kind: pipeline
metadata:
  name: codefresh-io/cli/from-external
  isPublic: false
  labels:
    tags: []
  deprecate:
    applicationPort: '8080'
    repoPipeline: true
  project: codefresh-io/cli
spec:
  triggers:
    - type: git
      repo: codefresh-io/cli
      events:
        - push.heads
      pullRequestAllowForkEvents: false
      commentRegex: /.*/gi
      branchRegex: /.*/gi
      branchRegexInput: regex
      provider: github
  contexts: []
  variables:
    - key: PORT
      value: '3000'
    - key: SECRET
      value: 'secret-value'
      encrypted: true
  specTemplate:
    location: url
    url: 'https://raw.githubusercontent.com/codefresh-io/cli/master/codefresh.yml'
  steps: {}
  stages: []