Integrating Buildkite with Mergify

Buildkite is a CI/CD tool providing scalable orchestration system, dynamic pipelines, customizable runners, and a great local development experience. Mergify can interact with Buildkite by evaluating the status checks reported by Buildkite to GitHub. This enables powerful automation workflows that react to the results of your Buildkite jobs.

Prerequisites

Before you can use Mergify with Buildkite, ensure the following:

1. Buildkite is properly set up and is building your projects. See the Buildkite Documentation for help with setting up Buildkite.

2. Buildkite is configured to report build statuses to GitHub.

3. The Mergify GitHub App is installed in your repository.

Using Buildkite Status Checks in Mergify Configuration

Once Buildkite reports status checks to GitHub, they can be used as conditions in your Mergify rules.

Here's a simple example:

1
pull_request_rules:
2
  - name: Automatically merge when Buildkite build succeeds
3
    conditions:
4
      - check-success=buildkite/github-test  # Change this to match your Buildkite check name
5
      - "#approved-reviews-by>=1"
6
    actions:
7
      merge:
8
        method: merge

In this example, Mergify will automatically merge pull requests that have at least one approved review and a successful Buildkite build.

Further Configuration

The possibilities of integrating Buildkite with Mergify are extensive. For instance, you could use Mergify to:

• Automatically update a PR when a build fails;

• Apply labels, request reviewers, or post comments based on the results of Jenkins checks.

We encourage you to explore Mergify's conditions and actions to create your personalized workflow.