1. Resources
  2. /
  3. Plugins
  4. /
  5. github-fetch-buildkite-plugin

github-fetch-buildkite-plugin

A Buildkite plugin to fetch a branch from GitHub.

Buildkite Agent Requirements

  • Git
  • AWS CLI (only if BUILDKITE_PLUGIN_GITHUB_FETCH_S3_URL is provided)

Configurations

The plugin accepts the following environment variables to configure its behaviour:

  • BUILDKITE_PLUGIN_GITHUB_FETCH_S3_URL

    • Required: No
    • Description: An S3 URL (e.g. s3://<bucket>/<key>) pointing to a “directory” in S3 which contains snapshots of the GitHub repository to checkout. The snapshots must be in tar.gz format and use the following naming convention: YYYYMMDD_HHmmss.tar.gz.

    Note: If this parameter is not specified the branch will be always checked out from the repository in GitHub.

  • BUILDKITE_PLUGIN_GITHUB_FETCH_GIT_REMOTE_TIMEOUT

    • Required: No
    • Default: 0 (no timeout)
    • Description: The maximum amount of time for Git remote operations (push pull fetch) to complete.
  • BUILDKITE_PLUGIN_GITHUB_FETCH_GIT_REMOTE_TIMEOUT_EXIT_CODE:

    • Required: No
    • Default: 110
    • Description: The exit code returned by the Buildkite step if any Git remote operation times out.
  • BUILDKITE_PLUGIN_GITHUB_FETCH_MAIN_REPO:

    • Required: No
    • Description: The main repo to be checked out.

    Note: This parameter has no effect if BUILDKITE_PLUGIN_GITHUB_FETCH_GIT_REMOTE_TIMEOUT is undefined or set to 0.

Exit Codes

Exit CodeDescription
116The target Git branch does not contain the specified commit.

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