---
name: "Sparse Checkout"
description: "Sparse Checkout of a Github repository."
author: "pragmaplatform"
repo: "sparse-checkout-buildkite-plugin-old"
stars: 2
official: false
version: "v1.1.14"
lastUpdated: "2021-08-11T22:46:23.000Z"
---

##############
# DEPRECATED - In favor of buildkite managed plugin
##############

# Sparse Checkout Buildkite Plugin

Sparse checkouts a directory from Github. Based on https://buildkite.com/docs/plugins/writing

## Example

Add the following to your `pipeline.yml`:

```yml
steps:
  - command: echo sparse-checkout
    plugins:
      - pragmaplatform/sparse-checkout#v1.1.9:
          paths: "dir1 dir2"
```

## Configuration

### `paths` (Required, list)

List of directory paths to sparse checkout.

## Developing

To run the tests:

```shell
docker-compose run --rm tests
```

## Contributing

1. Fork the repo
2. Make the changes
3. Run the tests
4. Commit and push your changes
5. Send a pull request