Cloud Build API: Nodejs Client

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

Cloud Build API client for Node.js

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

• Cloud Build API Nodejs Client API Reference

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

Table of contents:

• Quickstart

  • Before you begin
  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/cloudbuild

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | approve build | source code | | cancel build | source code | | create build | source code | | create build trigger | source code | | create worker pool | source code | | delete build trigger | source code | | delete worker pool | source code | | get build | source code | | get build trigger | source code | | get worker pool | source code | | list build triggers | source code | | list builds | source code | | list worker pools | source code | | receive trigger webhook | source code | | retry build | source code | | run build trigger | source code | | update build trigger | source code | | update worker pool | source code | | devtools | source code | | batch create repositories | source code | | create connection | source code | | create repository | source code | | delete connection | source code | | delete repository | source code | | fetch git refs | source code | | fetch linkable repositories | source code | | fetch read token | source code | | fetch read write token | source code | | get connection | source code | | get repository | source code | | list connections | source code | | list repositories | source code | | update connection | source code | | devtools | source code |

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.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE