Cloud Deploy API: Nodejs Client

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

Cloud Deploy API client for Node.js

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

• Cloud Deploy 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 Deploy API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/deploy

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | abandon release | source code | | advance rollout | source code | | approve rollout | source code | | cancel automation run | source code | | cancel rollout | source code | | create automation | source code | | create custom target type | source code | | create delivery pipeline | source code | | create deploy policy | source code | | create release | source code | | create rollout | source code | | create target | source code | | delete automation | source code | | delete custom target type | source code | | delete delivery pipeline | source code | | delete deploy policy | source code | | delete target | source code | | get automation | source code | | get automation run | source code | | get config | source code | | get custom target type | source code | | get delivery pipeline | source code | | get deploy policy | source code | | get job run | source code | | get release | source code | | get rollout | source code | | get target | source code | | ignore job | source code | | list automation runs | source code | | list automations | source code | | list custom target types | source code | | list delivery pipelines | source code | | list deploy policies | source code | | list job runs | source code | | list releases | source code | | list rollouts | source code | | list targets | source code | | retry job | source code | | rollback target | source code | | terminate job run | source code | | update automation | source code | | update custom target type | source code | | update delivery pipeline | source code | | update deploy policy | source code | | update target | source code | | cloud | 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/deploy@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