1. Resources
  2. /
  3. Plugins
  4. /
  5. git-s3-cache-buildkite-plugin

Git S3 Cache Buildkite Plugin

Adds a pre-checkout hook that downloads a git mirror from S3 and uses it as part of the checkout process.

Example

Add the following to your pipeline.yml:

steps:
  - command:
      - "yarn install"
      - "yarn run test"
    plugins:
      - automattic/git-s3-cache#v1.0.0:
          bucket: "my-s3-bucket"
          repo: "path-to-repo-in-s3/"

Configuration

Before using this plugin, you should have an S3 bucket set up in a format similar to:

my-bucket/
├── my-project/
│   ├── 2020-01-01-my-project.git
│   ├── 2020-01-03-my-project.git
│   ├── 2020-01-05-my-project.git

Or:

my-bucket/
├── my-project/
│   ├── 2000-01-01
│       ├── my-project.git
│   └── 2001-01-02
│       ├── my-project.git

Git mirrors must end in .git, and should be sorted alphabetically with the most recent mirror appearing last.

bucket (Required, string)

The S3 bucket containing your mirrors.

repo (Required, string)

The S3 path to the repo. For example my-org/my-project.

Developing

To run the tests:

docker-compose run --rm lint

Contributing

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

The plugins listed on this webpage are provided for informational purposes only. They have not undergone any formal security review or assessment. While we strive to provide useful resources, we cannot guarantee the safety, reliability, or integrity of these plugins. Users are strongly advised to conduct their own security evaluations before downloading, installing, or using any plugin. By using these plugins, you acknowledge and accept any risks associated with their use. We disclaim any liability for any harm or damages arising from the use of the plugins listed.

Start turning complexity into an advantage

Create an account to get started with a 30-day free trial. No credit card required.

Buildkite Pipelines

Platform

  1. Pipelines
  2. Pipeline templates
  3. Public pipelines
  4. Test Engine
  5. Package Registries
  6. Mobile Delivery Cloud
  7. Pricing

Hosting options

  1. Self-hosted agents
  2. Mac hosted agents
  3. Linux hosted agents

Resources

  1. Docs
  2. Blog
  3. Changelog
  4. Webinars
  5. Plugins
  6. Case studies
  7. Events
  8. Migration Services
  9. Comparisons

Company

  1. About
  2. Careers
  3. Press
  4. Brand assets
  5. Contact

Solutions

  1. Replace Jenkins
  2. Workflows for AI/ML
  3. Testing at scale
  4. Monorepo mojo
  5. Bazel orchestration

Legal

  1. Terms of Service
  2. Acceptable Use Policy
  3. Privacy Policy
  4. Subprocessors
  5. Service Level Agreement

Support

  1. System status
  2. Forum
© Buildkite Pty Ltd 2025