How to Use Buildkite

Getting started with Buildkite

In this guide, you will learn how to set up Buildkite for continuous integration and deployment, and how to run your first build pipeline quickly. You’ll be able to connect your repositories and automate your testing and deployment processes.

Step 1: Sign up and set up

1. Go to Buildkite's website and click on the Get Started button.
2. Enter your email address and create a password to create an account.
3. Confirm your email address by following the link sent to your inbox.
4. After logging in, you will be prompted to connect a source code repository. Choose your preferred platform (GitHub, GitLab, Bitbucket) and authorise Buildkite to access your repositories.

Step 2: Your first build pipeline

1. Once your repository is connected, click on the New Pipeline button in the dashboard.
2. Enter a name for your pipeline and select the repository you just connected.
3. Follow the instructions to create a buildkite.yml file in your repository. This file defines the steps of your build. Here’s a simple example:

steps:
     - label: "Build"
       command: "npm install"
     - label: "Test"
       command: "npm test"

1. Commit the buildkite.yml file to your repository.
2. Return to Buildkite and click on your pipeline to view it. You should see the build triggered automatically after the commit.

Step 3: Get better results

1. To optimise your builds, consider using environment variables for sensitive data. Click on the Settings tab in your pipeline and scroll to Environment Variables to add them.
2. Use the Build Triggers section to configure automatic builds on specific branches or pull requests.
3. Explore the Agent settings to set up multiple agents for parallel builds, allowing your team to run tests concurrently.

Pro tip

Most beginners overlook the Build Notifications feature. Go to your pipeline settings and enable notifications to receive updates on build statuses via email or Slack. This keeps your team informed without needing to check the dashboard constantly.

Common mistake to avoid

Many users forget to commit the buildkite.yml file to their repository, resulting in no builds being triggered. Ensure this file is present and correctly formatted in the root directory of your repository to activate your pipeline.