continuous-delivery-go-sdk

README

IBM Cloud Continuous Delivery Go SDK 1.0.0

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

Disclaimer: this SDK is in Beta, and is subject to breaking changes that may impact applications that use this 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 following IBM Cloud services:

Service Name	Package name
Toolchain API	cdtoolchainv2
Tekton Pipeline API	cdtektonpipelinev2

Prerequisites

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

Installation

The current version of this SDK: 1.0.0

Go modules

If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application.
Here is an example:

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

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 above, the cdtoolchainv2 part of the import path is the package name associated with the Toolchain service. See the service table above to find the approprate package name for the services used by your application.

go get command

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

go get -u github.com/IBM/continuous-delivery-go-sdk/cdtoolchainv2

Be sure to use the appropriate package name from the service table above for the services used by your application.

Using the SDK

For general SDK usage information, please see this link

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.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.