Sparse Checkout Buildkite Plugin

A Buildkite plugin for creating a sparse checkout of a repository.

This is useful for pipeline upload steps that dont need to access files outside the .buildkite directory. If your repository is large, this plugin will speed up your pipelines by only pulling the files relevant to the step.

Configuration

These are all the options available to configure this plugin's behaviour.

Required

paths (list of string)

Paths accepted by git sparse-checkout set.

Optional

no_cone ('true' or 'false')

Whether to pass --no-cone to git sparse-checkout so that the paths are considered to be a list of patterns.

skip_ssh_keyscan ('true' or 'false')

Whether to skip ssh-keyscan step. This will skip adding each ssh public key into the known-hosts file. Only use if ssh keys are already setup.

clean_checkout ('true' or 'false')

Whether to perform aggressive repository cleanup before checkout. This option handles scenarios where interrupted or cancelled jobs leave the git repository in a corrupted state with uncommitted changes that would prevent checkout. When enabled, it performs git reset --hard HEAD and git sparse-checkout disable in addition to the normal cleanup.

⚠️ Warning: This option will destroy ALL local changes and remove ALL untracked files. The git clean -ffxdq command with the -x flag will also remove ignored files (such as credentials, local configuration, or cache files). Only use this option when you're certain no important local data needs to be preserved.

Use this option for pipeline upload jobs that don't need to preserve local changes.

Example

Below is an example of using sparse-checkout plugin.

steps:
  - label: "Pipeline upload"
    command: "buildkite-agent pipeline upload"
    plugins:
      - sparse-checkout#v1.1.0:
          paths:
            - .buildkite

Handling corrupted repository states

If your jobs are frequently cancelled during the git clone phase, you may encounter failures due to uncommitted changes left in the repository. Use the clean_checkout option to handle this:

steps:
  - label: "Pipeline upload with clean checkout"
    command: "buildkite-agent pipeline upload"
    plugins:
      - sparse-checkout#v1.1.0:
          paths:
            - .buildkite
          clean_checkout: true

⚒ Developing

To run testing, shellchecks and plugin linting use bk run with the Buildkite CLI.

bk run

👩‍💻 Contributing

Your policy on how to contribute to the plugin!

📜 License

The package is available as open source under the terms of the MIT License.