Local Builder runs Google Cloud Build builds locally, allowing faster debugging, less vendor lock-in, and integration into local build and test workflows.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Google Cloud Build Local Builder

Local Builder runs Google Cloud Build locally, allowing easier debugging, execution of builds on your own hardware, and integration into local build and test workflows.


Prerequisites

  1. Ensure you have installed:

  2. If the build needs to access a private Google Container Registry, install and configure the Docker credential helper for Google Container Registry.

  3. Configure your project for the gcloud tool, where [PROJECT_ID] is your Cloud Platform project ID:

    gcloud config set project [PROJECT-ID]
    

Install using gcloud

  1. Install by running the following command:

    gcloud components install cloud-build-local
    

    After successful installation, you will have cloud-build-local in your PATH as part of the Google Cloud SDK binaries.

  2. To see all of the commands, run:

    $ cloud-build-local --help
    

    The Local Builder's command is $ cloud-build-local.

Download the latest binaries

The latest binaries are available in a GCS bucket.

Download the latest binaries from GCS.

To run a build:

./cloud-build-local_{linux,darwin}_{386,amd64}-v<latest_tag> --dryrun=false --config=path/to/cloudbuild.yaml path/to/code

Developing and contributing to the Local Builder

See the contributing instructions.

Limitations

  • Only one build can be run at a time on a given host.
  • The tool works on the following platforms:
    • Linux
    • macOS

Support

File issues here on gitHub, email cloud-build-contact@google.com, or join our Slack channel if you have general questions about Local Builder or Container Builder.