Buildkite Docs

Lightning fast testing and delivery for all your software projects.

Skip to main content

/

Tutorials

  • Getting Started
  • Elastic CI Stack for AWS
  • Docker-Based Builds
  • Parallelizing Builds
  • Migrating from Bamboo
  • Using Bazel on Buildkite
  • Migrating to YAML Steps
  • Two-factor authentication (2FA)

Agent

  • Overview
  • Installation
  • Upgrading
  • Configuration
  • SSH Keys
  • GitHub SSH Keys
  • Hooks
  • Queues
  • Prioritization
  • Securing
  • Tokens
  • Agent v2 (Deprecated)

Elastic CI Stack for AWS

  • Overview
  • Elastic CI Stack
  • Elastic CI Stack Template Parameters
  • Elastic CI Stack for EC2 Mac
  • CloudFormation Service Role
  • VPC Design for Elastic CI Stack
  • Using AWS Secrets Manager

Agent Installers

  • Ubuntu
  • Debian
  • Red Hat/CentOS
  • FreeBSD
  • macOS
  • Windows
  • Linux
  • Docker
  • AWS
  • Google Cloud

Command-Line Reference

  • start
  • annotate
  • artifact
  • meta-data
  • pipeline
  • bootstrap
  • step

Agent v2 (deprecated)

  • Overview
  • Installation
  • Upgrading to v2
  • Configuration
  • SSH Keys
  • GitHub SSH Keys
  • Hooks
  • Queues
  • Prioritization
  • Securing

Agent Installers

  • Ubuntu
  • Debian
  • Red Hat/CentOS
  • FreeBSD
  • macOS
  • Windows
  • Linux
  • Docker
  • AWS
  • Elastic CI Stack for AWS
  • Google Cloud

Command-Line Reference

  • start
  • meta-data
  • artifact
  • pipeline

Pipelines

  • Overview
  • Defining Steps
  • Writing Build Scripts
  • Using Conditionals
  • Step Dependencies
  • Environment Variables
  • Skipping Builds
  • Using Build Artifacts
  • Public Pipelines
  • Using Build Meta-data
  • Managing Log Output
  • Links & Images in Log Output
  • Notifications
  • Job Minutes
  • Example Pipelines

Step Types

  • Command Step
  • Wait Step
  • Block Step
  • Input Step
  • Trigger Step
  • Group Step

Workflows

  • Prioritizing Jobs
  • Controlling Concurrency
  • Build Matrix
  • Branch Configuration
  • Scheduled Builds

Security

  • Security Overview
  • Managing Secrets
  • Users and Teams
  • Webhooks Security
  • Audit Log

Plugins

  • Overview
  • Using Plugins
  • Plugins Directory
  • Plugin Tools
  • Writing Plugins

Deployments

  • Overview
  • Deploying to Heroku
  • Deploying to Kubernetes

Integrations

Source control

  • GitHub
  • GitHub Enterprise
  • GitLab
  • Bitbucket
  • Bitbucket Server
  • Phabricator
  • Other Git Servers

SSO

  • Overview
  • Okta
  • ADFS
  • Google Workspace
  • Google Workspace (SAML)
  • GitHub
  • OneLogin
  • Azure AD
  • Custom SAML
  • Setup with GraphQL

Other integrations

  • Amazon EventBridge
  • Artifactory
  • Build Status Badges
  • CCMenu & CCTray
  • PagerDuty
  • Slack

Test Analytics

  • Overview
  • Ruby Collectors
  • Importing JUnit XML
  • Importing JSON
  • Writing Your Own Collectors
  • Users and Teams

APIs

  • Managing API Tokens

Webhooks

  • Overview
  • Agent Events
  • Build Events
  • Job Events
  • Ping Events
  • Integrations

Buildkite REST API

  • Overview
  • Access Token
  • Organizations
  • Pipelines
  • Builds
  • Jobs
  • Agents
  • Artifacts
  • Annotations
  • Emojis
  • User
  • Meta

Agent REST API

  • Overview
  • Metrics

GraphQL API

  • Overview
  • Console and CLI tutorial
  • Cookbook
Home

Plugin Tools

The following tools can be helpful when creating and maintaining your own Buildkite plugins:

🔨 Buildkite Plugin Tester Docker image with a number of shell testing and stubbing tools. github.com/buildkite-plugins/plugin-tester

✨ Buildkite Plugin Linter Linter that checks your plugin for best practices. github.com/buildkite-plugins/buildkite-plugin-linter

🐚 Buildkite Shellcheck Plugin Plugin for detecting potential problems in your hook scripts. github.com/buildkite-plugins/shellcheck-buildkite-plugin

:terminal: Buildkite CLI Command line tool for running Buildkite pipelines entirely locally. github.com/buildkite/cli

📝 Release Drafter A GitHub App to help draft your release notes. github.com/release-drafter/release-drafter

🦆 Boomper A GitHub app for bumping the version numbers in your readme examples. github.com/toolmantim/boomper

For help writing the JSON Schema in the configuration key of your plugin.yml file, the following resources may be useful:

:json: JSON Schema The official JSON Schema specification. json-schema.org

:json: JSON Schema Lint Validating your JSON schema with YAML. jsonschemalint.com

:json: Understanding JSON Schema Tutorial to help understand how to write JSON Schema. spacetelescope.github.io/understanding-json-schema/

Spotted a typo? Something missing? Please open an issue or contribute an update.