IBM Cloud Continuous Delivery Node.js SDK
The Node.js client library to interact with the IBM Cloud Continuous Delivery Toolchain and Tekton Pipeline APIs.
Table of Contents
Overview
The IBM Cloud Continuous Delivery Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name | Import Path |
|---|---|
| Toolchain API | @ibm-cloud/continuous-delivery/cd-toolchain/v2 |
| Tekton Pipeline API | @ibm-cloud/continuous-delivery/cd-tektonpipeline/v2 |
Table 1. IBM Cloud services
Migration
ibm-continuous-delivery package has been deprecated!
The IBM Continuous Delivery Node SDK is now available as @ibm-cloud/continuous-delivery.
To migrate to the new package, you can use the commands listed below:
npm uninstall ibm-continuous-delivery
npm install @ibm-cloud/continuous-delivery
You will also need to modify any references to the old package ibm-continuous-delivery within import/require statements so they reflect the new package @ibm-cloud/continuous-delivery. Here is an example:
// 'require' statements that reflect the old package name:
const CdToolchainV2 = require("ibm-continuous-delivery/cd-toolchain/v2");
const CdTektonPipelineV2 = require("ibm-continuous-delivery/cd-tekton-pipeline/v2");
// Modify this to reflect the new package name:
const CdToolchainV2 = require("@ibm-cloud/continuous-delivery/cd-toolchain/v2");
const CdTektonPipelineV2 = require("@ibm-cloud/continuous-delivery/cd-tekton-pipeline/v2");Prerequisites
- You need an IBM Cloud account.
- Node.js >=14: This SDK is tested with Node.js versions 14 and up. It may work on previous versions but this is not officially supported.
Installation
npm install @ibm-cloud/continuous-deliveryUsing the SDK
For general SDK usage information, see IBM Cloud SDK Common README.
Questions
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow. Alternatively, you can reach out to the IBM Cloud Continuous Delivery development team by joining us on Slack.
Issues
If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.
Open source @ IBM
Find more open source projects on the IBM Github Page
Contributing
See CONTRIBUTING.
License
This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.