# README
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
-
Ensure you have installed:
-
If the build needs to access a private Google Container Registry, install and configure the Docker credential helper for Google Container Registry.
-
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
-
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. -
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
Our documentation has a page on getting
support. If you have
general questions about Local Builder or Cloud Build, you can file issues here
on GitHub, email [email protected]
, or join our.