circleci

Documentation

Index

• type CircleCI
• type Client
  • func NewClient(config *Config) (*Client, error)
  • func (c *Client) CreateProjectEnvVar(projectSlug, key, value string) (ProjectEnvVar, error)
  • func (c *Client) DeleteProjectEnvVar(projectSlug, key string) error
  • func (c *Client) GetAllPipelines(project Project) (Pipelines, error)
  • func (c *Client) GetAllProjects() (Projects, error)
  • func (c *Client) GetJobsForWorkflow(workflow Workflow) (Jobs, error)
  • func (c *Client) GetProjectEnvVars(projectSlug string) (ProjectEnvVars, error)
  • func (c *Client) GetWorkflowsForPipeline(pipeline Pipeline) (Workflows, error)
  • func (c *Client) JobLink(project Project, job Job) string
  • func (c *Client) PreviousCompleteWorkflowState(pipelines Pipelines, workflowName string) (string, error)
  • func (c *Client) WorkflowLink(project Project, pipeline Pipeline, workflow Workflow) string
  • func (c *Client) WorkflowStatus(pipelines Pipelines, workflow Workflow) (string, error)
• type Config
  • func DefaultConfig() *Config
• type Filter
• type Job
• type Jobs
• type MessageResponse
• type PagedResponse
• type Pipeline
• type Pipelines
  • func (p Pipelines) FilteredPerBranch(branchFilter string) map[string]Pipelines
  • func (p Pipelines) LatestPerBranch() map[string]Pipeline
• type Project
  • func (p *Project) Name() string
  • func (p *Project) Slug() string
• type ProjectEnvVar
• type ProjectEnvVars
• type Projects
  • func (p Projects) Filter(filter *Filter) Projects
• type VCS
• type Workflow
  • func (w *Workflow) BuildError() bool
• type Workflows
  • func (w *Workflows) BuildError() bool

Types

type CircleCI

type CircleCI interface {
	GetAllProjects() (Projects, error)
	GetProjectEnvVars(string) (ProjectEnvVars, error)
	CreateProjectEnvVar(string, string, string) (ProjectEnvVar, error)
	DeleteProjectEnvVar(string, string) error
	GetAllPipelines(Project) (Pipelines, error)
	GetWorkflowsForPipeline(Pipeline) (Workflows, error)
	GetJobsForWorkflow(Workflow) (Jobs, error)
	PreviousCompleteWorkflowState(Pipelines, string) (string, error)
	WorkflowLink(Project, Pipeline, Workflow) string
	JobLink(Project, Job) string
	WorkflowStatus(Pipelines, Workflow) (string, error)
}

type Client

type Client struct {
	Config *Config
	Client *resty.Client
}

func NewClient

func NewClient(config *Config) (*Client, error)

func (*Client) CreateProjectEnvVar

func (c *Client) CreateProjectEnvVar(projectSlug, key, value string) (ProjectEnvVar, error)

func (*Client) DeleteProjectEnvVar

func (c *Client) DeleteProjectEnvVar(projectSlug, key string) error

func (*Client) GetAllPipelines

func (c *Client) GetAllPipelines(project Project) (Pipelines, error)

func (*Client) GetAllProjects

func (c *Client) GetAllProjects() (Projects, error)

func (*Client) GetJobsForWorkflow

func (c *Client) GetJobsForWorkflow(workflow Workflow) (Jobs, error)

func (*Client) GetProjectEnvVars

func (c *Client) GetProjectEnvVars(projectSlug string) (ProjectEnvVars, error)

func (*Client) GetWorkflowsForPipeline

func (c *Client) GetWorkflowsForPipeline(pipeline Pipeline) (Workflows, error)

func (*Client) JobLink

func (c *Client) JobLink(project Project, job Job) string

func (*Client) PreviousCompleteWorkflowState

func (c *Client) PreviousCompleteWorkflowState(pipelines Pipelines, workflowName string) (string, error)

func (*Client) WorkflowLink

func (c *Client) WorkflowLink(project Project, pipeline Pipeline, workflow Workflow) string

func (*Client) WorkflowStatus

func (c *Client) WorkflowStatus(pipelines Pipelines, workflow Workflow) (string, error)

type Config

type Config struct {
	APIURL   string
	JobsURL  string
	APIToken string
}

func DefaultConfig

func DefaultConfig() *Config

type Filter

type Filter map[string]interface{}

type Job

type Job struct {
	ID string `json:"id"`
}

type Jobs

type Jobs []Job

type MessageResponse

type MessageResponse struct {
	Message string `json:"message"`
}

type PagedResponse

type PagedResponse struct {
	Items         json.RawMessage `json:"items"`
	NextPageToken *string         `json:"next_page_token"`
}

type Pipeline

type Pipeline struct {
	ID     string `json:"id"`
	Number int    `json:"number"`
	VCS    VCS    `json:"vcs"`
}

type Pipelines

type Pipelines []Pipeline

func (Pipelines) FilteredPerBranch

func (p Pipelines) FilteredPerBranch(branchFilter string) map[string]Pipelines

func (Pipelines) LatestPerBranch

func (p Pipelines) LatestPerBranch() map[string]Pipeline

type Project

type Project struct {
	VCSType  string                 `json:"vcs_type"`
	Username string                 `json:"username"`
	Reponame string                 `json:"reponame"`
	Branches map[string]interface{} `json:"branches"`
}

func (*Project) Name

func (p *Project) Name() string

func (*Project) Slug

func (p *Project) Slug() string

type ProjectEnvVar

type ProjectEnvVar struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ProjectEnvVars

type ProjectEnvVars []ProjectEnvVar

type Projects

type Projects []Project

func (Projects) Filter

func (p Projects) Filter(filter *Filter) Projects

type VCS

type VCS struct {
	Branch string `json:"branch"`
}

type Workflow

type Workflow struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	Status string `json:"status"`
}

func (*Workflow) BuildError

func (w *Workflow) BuildError() bool

type Workflows

type Workflows []Workflow

func (*Workflows) BuildError

func (w *Workflows) BuildError() bool