Skip to content

IBM/continuous-delivery-java-sdk

Repository files navigation

IBM Cloud Continuous Delivery Java SDK Version 1.3.0

Build Status Release License semantic-release

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

Table of Contents

Overview

The IBM Cloud Continuous Delivery Java SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Artifact Coordinates
Toolchain API com.ibm.cloud:cd-toolchain:1.3.0
Tekton Pipeline API com.ibm.cloud:cd-tekton-pipeline:1.3.0

Table 1. IBM Cloud services

Prerequisites

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

Installation

The current version of this SDK is: 1.3.0

Each service's artifact coordinates are listed in the table above.

The project artifacts are published on the public Maven Central artifact repository. This is the default public repository used by maven when searching for dependencies. To use this repository within a gradle build, please see this link.

To use a particular service, define a dependency that contains the artifact coordinates (group id, artifact id and version) for the service. Here are examples for maven and gradle:

Maven

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>cd-toolchain</artifactId>
    <version>1.3.0</version>
</dependency>
<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>cd-tekton-pipeline</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle

compile 'com.ibm.cloud:cd-toolchain:1.3.0'
compile 'com.ibm.cloud:cd-tekton-pipeline:1.3.0'

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. 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 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

The IBM Cloud Continuous Delivery Java SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.