circleciclient

Sep 21, 2026

Changes in this version

type Config

+ Transport http.RoundTripper

Sep 21, 2026

Changes in this version

+ const APIv2Suffix

+ func BaseURLFromAPIURL(apiURL string) string

+ func PipelineURL(org, repo string, number int64) string

+ func WorkflowRunning(status string) bool

type Client

+ func (c *Client) FindPipelineByTag(ctx context.Context, org, repo, tag string) (*Pipeline, error)

type Workflow

+ func NewestWorkflows(runs []Workflow) []Workflow

Sep 21, 2026

Changes in this version

type Client

+ func (c *Client) ListBranchPipelines(ctx context.Context, org, repo, branch, pageToken string) (*PipelinePage, error)

type Workflow

+ CreatedAt time.Time

Sep 17, 2026

Changes in this version

+ type PipelinePage struct

+ Items []Pipeline

+ NextPageToken string

Sep 16, 2026

Changes in this version

type Client

+ func (c *Client) Following(ctx context.Context, org, repo string) (bool, error)

+ func (c *Client) StopBuilding(ctx context.Context, org, repo string) error

Sep 16, 2026

Changes in this version

type Client

+ func (c *Client) Me(ctx context.Context) (*User, error)

+ type User struct

+ ID string

+ Login string

+ Name string

Sep 16, 2026

Changes in this version

+ const DefaultBaseURL

+ const KeyTypeDeployKey

+ func IsAPI(err error) bool

+ func IsInvalidConfig(err error) bool

+ func IsNotFound(err error) bool

+ func WorkflowFailed(status string) bool

+ func WorkflowSucceeded(status string) bool

+ type AdvancedSettings struct

+ SetupWorkflows *bool

+ type CheckoutKey struct

+ CreatedAt time.Time

+ Fingerprint string

+ Preferred bool

+ PublicKey string

+ Type string

+ type Client struct

+ func New(config Config) (*Client, error)

+ func (c *Client) CreateCheckoutKey(ctx context.Context, org, repo, keyType string) (*CheckoutKey, error)

+ func (c *Client) Follow(ctx context.Context, org, repo string) error

+ func (c *Client) GetProject(ctx context.Context, org, repo string) (*Project, error)

+ func (c *Client) GetProjectSettings(ctx context.Context, org, repo string) (*ProjectSettings, error)

+ func (c *Client) ListCheckoutKeys(ctx context.Context, org, repo string) ([]CheckoutKey, error)

+ func (c *Client) ListPipelineWorkflows(ctx context.Context, pipelineID string) ([]Workflow, error)

+ func (c *Client) ListPipelines(ctx context.Context, org, repo string) ([]Pipeline, error)

+ func (c *Client) ListWorkflowJobs(ctx context.Context, workflowID string) ([]Job, error)

+ func (c *Client) TriggerPipeline(ctx context.Context, org, repo string, req TriggerRequest) (*Pipeline, error)

+ func (c *Client) Unfollow(ctx context.Context, org, repo string) error

+ func (c *Client) UpdateProjectSettings(ctx context.Context, org, repo string, settings ProjectSettings) (*ProjectSettings, error)

+ type Config struct

+ BaseURL string

+ HTTPClient *http.Client

+ Logger *logrus.Logger

+ Token string

+ type Job struct

+ Name string

+ Status string

+ Type string

+ type Pipeline struct

+ CreatedAt time.Time

+ ID string

+ Number int64

+ State string

+ VCS PipelineVCS

+ type PipelineVCS struct

+ Branch string

+ Revision string

+ Tag string

+ type Project struct

+ ID string

+ Name string

+ OrganizationName string

+ Slug string

+ VCSInfo VCSInfo

+ type ProjectSettings struct

+ Advanced AdvancedSettings

+ type TriggerRequest struct

+ Branch string

+ Tag string

+ type VCSInfo struct

+ DefaultBranch string

+ Provider string

+ VCSURL string

+ type Workflow struct

+ ID string

+ Name string

+ PipelineNumber int64

+ Status string