Skip to content

Buildkite

Connects to the Buildkite REST API and displays status of branches for configured Pipelines.

The API token must have the read_builds permission.

Configuration

buildkite:
  apiKey: "p0d13*********************************************c3"
  enabled: true
  organizationSlug: "acme-corp"
  refreshInterval: 1m
  position:
    top: 1
    left: 1
    height: 1
    width: 1
  pipelines:
    pipeline-slug-1:
      branches:
        - "master"
        - "stage"
    pipeline-slug-2:
      branches:
        - "master"
        - "production"

Attributes

Name Value
apiKey
Your Buildkite API key. Leave this blank to use the WTF_BUILDKITE_TOKEN environment variable.
organizationSlug
The slug of your organization 		org.slug
pipelines
A hash with pipeline.slug as keys, mapping to a list of branches.

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/buildkite