bkyml 1.0.1

CLI tool to generate Buildkite pipeline YAML

A CLI tool to generate a pipeline.yaml file for Buildkite on the fly.

Example:

bkyaml comment 'Frontend tests pipeline'
bkyaml env FORCE_COLOR=1
bkyaml steps
bkyml command \
  --command 'yarn install' \
  --command 'yarn test' \
  --label ':karma: tests'

will produce

# Frontend tests pipeline
env:
  FORCE_COLOR: 1
steps:
  - label: ':karma: tests'
    command:
      - yarn install
      - yarn test

This allows you to dynamically generate pipelines:

#!/bin/env bash
set -eu -o pipefail

bkyml comment "Pipeline for running all tests in test/*"
bkyml steps

# add a new command step to run the tests in each test directory
for test_dir in test/*/; do
  bkyml command \
      --command "run_tests ${test_dir}" \
      --label "Run tests for '${test_dir}'"
done

Sub-Commands

steps

Example:

bkyml steps

will produce

steps:

comment

Example:

bkyml comment \
  bla foo

will produce

# bla foo

env

Example:

bkyaml env \
  --var A B \
  --var C D

will produce

env:
  A: B
  C: D

command

Example:

bkyaml command \
    --command 'yarn install' \
    --command 'yarn test' \
    --env FORCE_COLOR 1 \
    --branches master \
    --label ':yarn: tests' \
    --agents yarn true \
    --artifact-paths 'logs/**/*' 'coverage/**/*' \
    --parallelism 5 \
    --concurrency 2 \
    --concurrency-group my/group \
    --timeout-in-minutes 60 \
    --skip 'Some reason' \
    --retry automatic \
    --retry-automatic-tuple '*' 2 \
    --retry-automatic-tuple 1 3

will produce

- label: ':yarn: tests'
  command:
    - yarn install
    - yarn test
  branches: master
  env:
    FORCE_COLOR: '1'
  agents:
    yarn: 'true'
  artifact_paths:
    - logs/**/*
    - coverage/**/*
  parallelism: 5
  concurrency: 2
  concurrency_group: my/group
  timeout_in_minutes: 60
  skip: Some reason
  retry:
    automatic:
      - exit_status: '*'
        limit: 2
      - exit_status: 1
        limit: 3

There is also:

• --retry-automatic-limit

• --retry-automatic-exit-code

which can’t be used in conjunction with –retry-automatic-tuple

And:

• --retry-manual-allowed (allowing manual retries, default)

• --no-retry-manual-allowed (disallowing manual retries)

• --retry-manual-reason REASON (giving a reason why retries are forbidden)

• --retry-manual-permit-on-passed (allowing retries after the job has passed)

• --no-retry-manual-permit-on-passed (disallowing retries after the job has passed, default)

Example:

bkyaml command \
  --command 'x' \
  --retry manual \
  --retry-manual-permit-on-passed \
  --no-retry-manual-allowed \
  --retry-manual-reason "Just because"

will result in

- command: x
  retry:
    manual:
      allowed: false
      reason: Just because
      permit_on_passed: true