Cloud Build: Node.js Client

release level npm version

Cloud Build API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Build API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/cloudbuild

Using the client library

async function quickstart(
  projectId = 'YOUR_PROJECT_ID', // Your Google Cloud Platform project ID
  triggerId = 'YOUR_TRIGGER_ID', // UUID for build trigger.
  branchName = 'BRANCH_TO_BUILD' // Branch to run build against.
) {
  // Imports the Google Cloud client library
  const {CloudBuildClient} = require('@google-cloud/cloudbuild');

  // Creates a client
  const cb = new CloudBuildClient();

  // Note: for Private Pools, you'll have to specify an API endpoint value
  // For example:
  // const cb = new CloudBuildClient({ apiEndpoint: '<YOUR_POOL_REGION>' });

  // Starts a build against the branch provided.
  const [resp] = await cb.runBuildTrigger({
    source: {
      dir: './',
  });`triggered build for ${triggerId}`);
  const [build] = await resp.promise();

  const STATUS_LOOKUP = [
  for (const step of build.steps) {
      `step:\n\tname: ${}\n\tstatus: ${STATUS_LOOKUP[build.status]}`


Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Cloud_build.approve_buildsource codeOpen in Cloud Shell
Cloud_build.cancel_buildsource codeOpen in Cloud Shell
Cloud_build.create_buildsource codeOpen in Cloud Shell
Cloud_build.create_build_triggersource codeOpen in Cloud Shell
Cloud_build.create_worker_poolsource codeOpen in Cloud Shell
Cloud_build.delete_build_triggersource codeOpen in Cloud Shell
Cloud_build.delete_worker_poolsource codeOpen in Cloud Shell
Cloud_build.get_buildsource codeOpen in Cloud Shell
Cloud_build.get_build_triggersource codeOpen in Cloud Shell
Cloud_build.get_worker_poolsource codeOpen in Cloud Shell
Cloud_build.list_build_triggerssource codeOpen in Cloud Shell
Cloud_build.list_buildssource codeOpen in Cloud Shell
Cloud_build.list_worker_poolssource codeOpen in Cloud Shell
Cloud_build.receive_trigger_webhooksource codeOpen in Cloud Shell
Cloud_build.retry_buildsource codeOpen in Cloud Shell
Cloud_build.run_build_triggersource codeOpen in Cloud Shell
Cloud_build.update_build_triggersource codeOpen in Cloud Shell
Cloud_build.update_worker_poolsource codeOpen in Cloud Shell
Repository_manager.batch_create_repositoriessource codeOpen in Cloud Shell
Repository_manager.create_connectionsource codeOpen in Cloud Shell
Repository_manager.create_repositorysource codeOpen in Cloud Shell
Repository_manager.delete_connectionsource codeOpen in Cloud Shell
Repository_manager.delete_repositorysource codeOpen in Cloud Shell
Repository_manager.fetch_git_refssource codeOpen in Cloud Shell
Repository_manager.fetch_linkable_repositoriessource codeOpen in Cloud Shell
Repository_manager.fetch_read_tokensource codeOpen in Cloud Shell
Repository_manager.fetch_read_write_tokensource codeOpen in Cloud Shell
Repository_manager.get_connectionsource codeOpen in Cloud Shell
Repository_manager.get_repositorysource codeOpen in Cloud Shell
Repository_manager.list_connectionssource codeOpen in Cloud Shell
Repository_manager.list_repositoriessource codeOpen in Cloud Shell
Repository_manager.update_connectionsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Cloud Build Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/cloudbuild@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0