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: "3276d7155dd9ee27b8b14f8743a408a9"
  enabled: true
  organizationSlug: "acme-corp"
  refreshInterval: 60
  position:
    top: 1
    left: 1
    height: 1
    width: 1
  pipelines:
    pipeline-slug-1:
      branches:
        - "master"
        - "stage"
    pipeline-slug-2:
      branches:
        - "master"
        - "production"
Name Description Value
apiKey Your Buildkite API token. Your API key or leave it empty to use the WTF_BUILDKITE_TOKEN environment variable.
border Optional Whether or not to draw this widget with a border. Default: true. true, false
enabled Optional Whether or not this module is executed and if its data displayed onscreen. Default: false. true, false
organizationSlug The slug of your organization org.slug
pipelines A hash with pipeline.slug as keys, mapping to a list of branches
position Defines where in the grid this module’s widget will be displayed.
refreshInterval Optional How often, in seconds, this module will update its data. Default: 300. Any positive integer.

Source Code

wtf/modules/buildkite/