SDK

What is the SaturnCI SDK?

On SaturnCI, a CI/CD pipeline is a Ruby file called a workflow. The SaturnCI SDK is the Ruby gem that workflow is written against: it's how the workflow looks at the state of a commit's pipeline and decides what to start next.

Installation

Inside a workflow, nothing. SaturnCI runs your workflow in a container that already has the SDK installed.

To use the SDK from your own machine or scripts, install it from its repository at a tagged release:

gem 'saturnci-sdk', git: 'https://github.com/saturnci/saturnci-sdk.git', tag: 'v1.0.2'

Usage

See Workflows for how a workflow runs and what the SDK is used for inside one. The SDK README has the full reference for SaturnCI::Client, SaturnCI::WorkflowRun, SaturnCI::JobRun, and SaturnCI::TestSuiteRun.

Outside a workflow, the SDK reads credentials from ~/.saturnci/credentials.json. See API Authentication for setup instructions.