IBM Cloud Continuous Delivery Go SDK

The Go client library to interact with the IBM Cloud Continuous Delivery Toolchain and Tekton Pipeline APIs.

Table of Contents

• IBM Cloud Continuous Delivery Go SDK
  • Table of Contents
  • Overview
  • Prerequisites
  • Installation
    • Go modules
    • go get command
  • Using the SDK
  • Questions
  • Issues
  • Open source @ IBM
  • Contributing
  • License

Overview

The IBM Cloud Continuous Delivery Go SDK allows developers to programmatically interact with the IBM Cloud services that are listed in Table 1:

Service name	Package name
Toolchain API	cdtoolchainv2
Tekton Pipeline API	cdtektonpipelinev2

Table 1. IBM Cloud services

Prerequisites

• An IBM Cloud account.
• An IAM API key to allow the SDK to access your account. Create an API key.
• Go version 1.25 or above.

Installation

The current version of this SDK: 2.0.8

Go modules

If your application uses Go modules for dependency management (recommended), add an import for each service that you use in your application.

Example:

import (
  "github.com/IBM/continuous-delivery-go-sdk/v2/cdtoolchainv2"
)
import (
  "github.com/IBM/continuous-delivery-go-sdk/v2/cdtektonpipelinev2"
)

Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.

In the example, the cdtoolchainv2 part of the first import path is the package name that is associated with the Toolchain service, and the cdtektonpipelinev2 part of the second import path is the package name that is associated with the Tekton Pipeline service. See Table 1 to find the appropriate package name for the services that your application uses.

go get command

Alternatively, you can use the go get command to download and install the appropriate packages that your application uses:

go get -u github.com/IBM/continuous-delivery-go-sdk/v2/cdtoolchainv2
# and/or
go get -u github.com/IBM/continuous-delivery-go-sdk/v2/cdtektonpipelinev2

Be sure to use the appropriate package name from Table 1 for the services that your application uses.

Using the SDK

For general SDK usage information, see IBM Cloud SDK Common README.

Issues

If you have a problem with the project, submit a bug report, but before you do, search for similar problems. Someone else might have already reported the problem.

Open source @ IBM

Find more open source projects on the IBM GitHub Page.

Contributing

For more information, see CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. You can find the license's full text in LICENSE.