cci

Documentation

Index

• type Client
  • func CreateClient(baseUrl string, apiKey string) *Client
  • func (client Client) CancelWorkflow(workflowId string) error
  • func (client Client) CreatePipeline(branch string) (int, error)
  • func (client Client) GetBranchPipelines(branch string) ([]Pipeline, error)
  • func (client Client) GetPipelineWorkflows(pipelineId string) ([]Workflow, error)
• type Pipeline
• type Workflow

Types

type Client

type Client struct {
	ProjectSlug string
	// contains filtered or unexported fields
}

func CreateClient

func CreateClient(baseUrl string, apiKey string) *Client

func (Client) CancelWorkflow

func (client Client) CancelWorkflow(workflowId string) error

Cancels a workflow.

func (Client) CreatePipeline

func (client Client) CreatePipeline(branch string) (int, error)

func (Client) GetBranchPipelines

func (client Client) GetBranchPipelines(branch string) ([]Pipeline, error)

Fetches the pipelines of a given VCS branch.

func (Client) GetPipelineWorkflows

func (client Client) GetPipelineWorkflows(pipelineId string) ([]Workflow, error)

Fetches the workflows of a given pipeline.

type Pipeline

type Pipeline struct {
	Id        string `json:"id"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	Number    int    `json:"number"`
	State     string `json:"state"`
}

type Workflow

type Workflow struct {
	Id     string `json:"id"`
	Name   string `json:"name"`
	Status string `json:"status"` // Can be one of: success, canceled, running, failed
}