@oneci/spec

top level attributes

image

Image

Docker image to use for this pipeline.

examples

image: node

always

Script

Execute these scripts for all jobs (before job specific scripts).

examples

always:
  - yarn

jobs

array<Job>

Specify one or more jobs to run in sequence. Optionally group in stages, to run sequential and in parallel at the same time.

examples

jobs:
  - [Job]
  - [Job]

type definitions

Image

string

Docker image.

Job

object

properties

• name string (optional): Descriptive name for the job, no functional effect.
• group string (optional): Run all jobs in this group in parallel.
• image string (optional): Override pipeline image for this job.
• script Script (optional): Execute these scripts as part of the job.

examples

# Runs three jobs, the first two run in parallel, the last one
# only runs when the first two were successful.
jobs:
  - name: lint
    group: test
    script: [Script]
  - name: build
    group: test
    script: [Script]
  - group: deploy
    image: mesosphere/aws-cli
    script: [Script]

Script

array<string>

One or more commands to execute as part of a job

examples

# This config defines two jobs, one runs the tests,
# the other runs two scripts to deploy and ping slack.
jobs:
  - script:
      - test.sh
  - script:
      - deploy.sh
      - ping-slack.sh