circleci

package module

Go to main page

Versions in this module

v0

v0.7.1

May 17, 2021

v0.7.0

May 17, 2021

Changes in this version

+ type CancelWorkflow struct

+ Message string

type Client

+ func (c *Client) CancelWorkflow(workflowID string) (*CancelWorkflow, error)

+ func (c *Client) CancelWorkflowWithContext(ctx context.Context, workflowID string) (*CancelWorkflow, error)

v0.6.0

May 17, 2021

Changes in this version

+ type Actor struct

+ AvatarURL string

+ Login string

type Client

+ func (c *Client) GetPipelineByBranch(vcsType VcsType, account, repo, branch, pageToken string) (*Pipelines, error)

+ func (c *Client) GetPipelineByBranchWithContext(ctx context.Context, vcsType VcsType, account, repo, branch, pageToken string) (*Pipelines, error)

+ type Items struct

+ CreatedAt string

+ ID string

+ Number int

+ ProjectSlug string

+ State string

+ Trigger Trigger

+ UpdatedAt string

+ Vcs Vcs

+ type Pipelines struct

+ Items []Items

+ NextPageToken interface{}

+ type Trigger struct

+ Actor Actor

+ ReceivedAt string

+ Type string

+ type Vcs struct

+ Branch string

+ OriginRepositoryURL string

+ ProviderName string

+ Revision string

+ TargetRepositoryURL string

v0.5.1

Aug 21, 2020

v0.5.0

Aug 10, 2020

Changes in this version

+ type APIVersion uint8

+ const APIVersion11

+ const APIVersion2

+ const APIVersionNone

+ func (v APIVersion) String() string

type Client

+ Version APIVersion

+ func NewClient(token string, version APIVersion) (*Client, error)

+ func (c *Client) GetPipelineWorkflow(pipelineID, pageToken string) (*WorkflowList, error)

+ func (c *Client) GetPipelineWorkflowWithContext(ctx context.Context, pipelineID, pageToken string) (*WorkflowList, error)

+ func (c *Client) TriggerPipeline(vcsType VcsType, account, repo, branch, tag string, ...) (*Pipeline, error)

+ func (c *Client) TriggerPipelineWithContext(ctx context.Context, vcsType VcsType, account, repo, branch, tag string, ...) (*Pipeline, error)

+ type InvalidVersionError struct

+ func (e *InvalidVersionError) Error() string

+ type Pipeline struct

+ CreatedAt time.Time

+ ID string

+ Number int

+ State string

+ type WorkflowItem struct

+ CanceledBy string

+ CreatedAt time.Time

+ ErroredBy string

+ ID string

+ Name string

+ Number int

+ ProjectSlug string

+ StartedBy string

+ Status string

+ StoppedAt time.Time

+ WorkflowID string

+ type WorkflowList struct

+ Items []WorkflowItem

+ NextPageToken string

v0.4.0

Jul 2, 2020

Changes in this version

+ type BuildByProjectResponse struct

+ Body string

+ Status int

type Client

+ func (c *Client) AddEnvVarWithContext(ctx context.Context, vcsType VcsType, account, repo, name, value string) (*EnvVar, error)

+ func (c *Client) AddHerokuKeyWithContext(ctx context.Context, key string) error

+ func (c *Client) AddSSHKeyWithContext(ctx context.Context, vcsType VcsType, ...) error

+ func (c *Client) AddSSHUserWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) (*Build, error)

+ func (c *Client) BuildByProject(vcsType VcsType, account string, repo string, opts map[string]interface{}) error

+ func (c *Client) BuildByProjectBranch(vcsType VcsType, account, repo, branch string) error

+ func (c *Client) BuildByProjectBranchWithContext(ctx context.Context, vcsType VcsType, account, repo, branch string) error

+ func (c *Client) BuildByProjectRevision(vcsType VcsType, account string, repo string, revision string) error

+ func (c *Client) BuildByProjectRevisionWithContext(ctx context.Context, vcsType VcsType, account, repo, revision string) error

+ func (c *Client) BuildByProjectTag(vcsType VcsType, account, repo, tag string) error

+ func (c *Client) BuildByProjectTagWithContext(ctx context.Context, vcsType VcsType, account, repo, tag string) error

+ func (c *Client) BuildByProjectWithContext(ctx context.Context, vcsType VcsType, account, repo string, ...) error

+ func (c *Client) BuildOptsWithContext(ctx context.Context, vcsType VcsType, account, repo, branch string, ...) (*Build, error)

+ func (c *Client) BuildWithContext(ctx context.Context, vcsType VcsType, account, repo, branch string) (*Build, error)

+ func (c *Client) CancelBuildWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) (*Build, error)

+ func (c *Client) ClearCacheWithContext(ctx context.Context, vcsType VcsType, account, repo string) (string, error)

+ func (c *Client) CreateCheckoutKeyWithContext(ctx context.Context, vcsType VcsType, account, repo, keyType string) (*CheckoutKey, error)

+ func (c *Client) DeleteCheckoutKeyWithContext(ctx context.Context, vcsType VcsType, account, repo, fingerprint string) error

+ func (c *Client) DeleteEnvVarWithContext(ctx context.Context, vcsType VcsType, account, repo, name string) error

+ func (c *Client) DisableProjectWithContext(ctx context.Context, vcsType VcsType, account, repo string) error

+ func (c *Client) EnableProjectWithContext(ctx context.Context, vcsType VcsType, account, repo string) error

+ func (c *Client) FollowProjectWithContext(ctx context.Context, vcsType VcsType, account, repo string) (*Project, error)

+ func (c *Client) GetActionOutputsWithContext(ctx context.Context, a *Action) ([]*Output, error)

+ func (c *Client) GetBuildWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) (*Build, error)

+ func (c *Client) GetCheckoutKeyWithContext(ctx context.Context, vcsType VcsType, account, repo, fingerprint string) (*CheckoutKey, error)

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

+ func (c *Client) ListBuildArtifactsWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) ([]*Artifact, error)

+ func (c *Client) ListCheckoutKeysWithContext(ctx context.Context, vcsType VcsType, account, repo string) ([]*CheckoutKey, error)

+ func (c *Client) ListEnvVarsWithContext(ctx context.Context, vcsType VcsType, account, repo string) ([]EnvVar, error)

+ func (c *Client) ListProjectsWithContext(ctx context.Context) ([]*Project, error)

+ func (c *Client) ListRecentBuildsForProjectWithContext(ctx context.Context, vcsType VcsType, account, repo, branch, status string, ...) ([]*Build, error)

+ func (c *Client) ListRecentBuildsWithContext(ctx context.Context, limit, offset int) ([]*Build, error)

+ func (c *Client) ListTestMetadataWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) ([]*TestMetadata, error)

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

+ func (c *Client) ParameterizedBuildWithContext(ctx context.Context, vcsType VcsType, account, repo, branch string, ...) (*Build, error)

+ func (c *Client) RetryBuildWithContext(ctx context.Context, vcsType VcsType, account, repo string, buildNum int) (*Build, error)

+ func (c *Client) UnfollowProject(vcsType VcsType, account, repo string) (*Project, error)

+ func (c *Client) UnfollowProjectWithContext(ctx context.Context, vcsType VcsType, account, repo string) (*Project, error)

+ type VcsType string

+ const VcsTypeBitbucket

+ const VcsTypeGithub

v0.3.0

Jun 29, 2019

Changes in this version

type Action

+ Background bool

type Build

+ Picard *Picard

+ Platform string

+ PullRequests []*PullRequest

+ Workflows *Workflow

+ type BuildAgent struct

+ Image *string

+ Properties *BuildAgentProperties

+ type BuildAgentProperties struct

+ BuildAgent string

+ Executor string

type Client

+ func (c *Client) BuildOpts(account, repo, branch string, opts map[string]interface{}) (*Build, error)

type CommitDetails

+ Branch string

+ type Picard struct

+ BuildAgent *BuildAgent

+ Executor string

+ ResourceClass *ResourceClass

+ type PullRequest struct

+ HeadSha string

+ URL string

+ type ResourceClass struct

+ CPU float64

+ Class string

+ RAM int

+ type Workflow struct

+ JobId string

+ JobName string

+ UpstreamJobIds []*string

+ WorkflowId string

+ WorkflowName string

+ WorkspaceId string

v0.2.0

Mar 10, 2018

Changes in this version

+ type FeatureFlags struct

+ AutocancelBuilds bool

+ BuildForkPRs bool

+ BuildPRsOnly bool

+ Fleet *string

+ ForksReceiveSecretVars bool

+ MemoryLimit *string

+ OSS bool

+ OSX bool

+ SetGithubStatus bool

+ TrustyBeta bool

+ func (f *FeatureFlags) Raw() map[string]interface{}

+ func (f *FeatureFlags) UnmarshalJSON(b []byte) error

v0.1.0

Dec 15, 2017

Changes in this version

+ type APIError struct

+ HTTPStatusCode int

+ Message string

+ func (e *APIError) Error() string

+ type AWSConfig struct

+ AWSKeypair *AWSKeypair

+ type AWSKeypair struct

+ AccessKeyID string

+ SecretAccessKey string

+ type Action struct

+ BashCommand *string

+ Canceled *bool

+ Continue *string

+ EndTime *time.Time

+ ExitCode *int

+ Failed *bool

+ HasOutput bool

+ Index int

+ InfrastructureFail *bool

+ Messages []string

+ Name string

+ OutputURL string

+ Parallel bool

+ RunTimeMillis int

+ StartTime *time.Time

+ Status string

+ Step int

+ Timedout *bool

+ Truncated bool

+ Type string

+ type Artifact struct

+ NodeIndex int

+ Path string

+ PrettyPath string

+ URL string

+ type Branch struct

+ LastSuccess *BuildSummary

+ PusherLogins []string

+ RecentBuilds []*BuildSummary

+ RunningBuilds []*BuildSummary

+ type Build struct

+ AllCommitDetails []*CommitDetails

+ AuthorDate *time.Time

+ AuthorEmail string

+ AuthorName string

+ Body string

+ Branch string

+ BuildNum int

+ BuildParameters map[string]string

+ BuildTimeMillis *int

+ BuildURL string

+ Canceled bool

+ CircleYML *CircleYML

+ CommitterDate *time.Time

+ CommitterEmail string

+ CommitterName string

+ Compare *string

+ DontBuild *string

+ Failed *bool

+ FeatureFlags map[string]string

+ InfrastructureFail bool

+ IsFirstGreenBuild bool

+ JobName *string

+ Lifecycle string

+ Messages []*Message

+ Node []*Node

+ OSS bool

+ Outcome string

+ Parallel int

+ Previous *BuildStatus

+ PreviousSuccessfulBuild *BuildStatus

+ QueuedAt string

+ Reponame string

+ Retries []int

+ RetryOf *int

+ SSHEnabled *bool

+ SSHUsers []*SSHUser

+ StartTime *time.Time

+ Status string

+ Steps []*Step

+ StopTime *time.Time

+ Subject string

+ Timedout bool

+ UsageQueuedAt string

+ User *BuildUser

+ Username string

+ VCSURL string

+ VcsRevision string

+ VcsTag string

+ Why string

+ type BuildStatus struct

+ BuildNum int

+ BuildTimeMillis int

+ Status string

+ type BuildSummary struct

+ AddedAt time.Time

+ BuildNum int

+ Outcome string

+ PushedAt time.Time

+ Status string

+ VCSRevision string

+ type BuildUser struct

+ Email *string

+ IsUser bool

+ Login string

+ Name *string

+ type CheckoutKey struct

+ Fingerprint string

+ Login *string

+ Preferred bool

+ PublicKey string

+ Time time.Time

+ Type string

+ type CircleYML struct

+ String string

+ type Client struct

+ BaseURL *url.URL

+ Debug bool

+ HTTPClient *http.Client

+ Logger Logger

+ Token string

+ func (c *Client) AddEnvVar(account, repo, name, value string) (*EnvVar, error)

+ func (c *Client) AddHerokuKey(key string) error

+ func (c *Client) AddSSHKey(account, repo, hostname, privateKey string) error

+ func (c *Client) AddSSHUser(account, repo string, buildNum int) (*Build, error)

+ func (c *Client) Build(account, repo, branch string) (*Build, error)

+ func (c *Client) CancelBuild(account, repo string, buildNum int) (*Build, error)

+ func (c *Client) ClearCache(account, repo string) (string, error)

+ func (c *Client) CreateCheckoutKey(account, repo, keyType string) (*CheckoutKey, error)

+ func (c *Client) DeleteCheckoutKey(account, repo, fingerprint string) error

+ func (c *Client) DeleteEnvVar(account, repo, name string) error

+ func (c *Client) DisableProject(account, repo string) error

+ func (c *Client) EnableProject(account, repo string) error

+ func (c *Client) FollowProject(account, repo string) (*Project, error)

+ func (c *Client) GetActionOutputs(a *Action) ([]*Output, error)

+ func (c *Client) GetBuild(account, repo string, buildNum int) (*Build, error)

+ func (c *Client) GetCheckoutKey(account, repo, fingerprint string) (*CheckoutKey, error)

+ func (c *Client) GetProject(account, repo string) (*Project, error)

+ func (c *Client) ListBuildArtifacts(account, repo string, buildNum int) ([]*Artifact, error)

+ func (c *Client) ListCheckoutKeys(account, repo string) ([]*CheckoutKey, error)

+ func (c *Client) ListEnvVars(account, repo string) ([]EnvVar, error)

+ func (c *Client) ListProjects() ([]*Project, error)

+ func (c *Client) ListRecentBuilds(limit, offset int) ([]*Build, error)

+ func (c *Client) ListRecentBuildsForProject(account, repo, branch, status string, limit, offset int) ([]*Build, error)

+ func (c *Client) ListTestMetadata(account, repo string, buildNum int) ([]*TestMetadata, error)

+ func (c *Client) Me() (*User, error)

+ func (c *Client) ParameterizedBuild(account, repo, branch string, buildParameters map[string]string) (*Build, error)

+ func (c *Client) RetryBuild(account, repo string, buildNum int) (*Build, error)

+ type CommitDetails struct

+ AuthorDate *time.Time

+ AuthorEmail string

+ AuthorLogin string

+ AuthorName string

+ Body string

+ Commit string

+ CommitURL string

+ CommitterDate *time.Time

+ CommitterEmail string

+ CommitterLogin string

+ CommitterName string

+ Subject string

+ type EnvVar struct

+ Name string

+ Value string

+ type Logger interface

+ Printf func(fmt string, args ...interface{})

+ type Message struct

+ Message string

+ Type string

+ type Node struct

+ ImageID string

+ Port int

+ PublicIPAddr string

+ SSHEnabled *bool

+ Username string

+ type Output struct

+ Message string

+ Time time.Time

+ Type string

+ type Project struct

+ AWSConfig AWSConfig

+ Branches map[string]Branch

+ CampfireNotifyPrefs *string

+ CampfireRoom *string

+ CampfireSubdomain *string

+ CampfireToken *string

+ Compile string

+ DefaultBranch string

+ Dependencies string

+ Extra string

+ FeatureFlags map[string]bool

+ FlowdockAPIToken *string

+ Followed bool

+ HallNotifyPrefs *string

+ HallRoomAPIToken *string

+ HasUsableKey bool

+ HerokuDeployUser *string

+ HipchatAPIToken *string

+ HipchatNotify *bool

+ HipchatNotifyPrefs *string

+ HipchatRoom *string

+ IrcChannel *string

+ IrcKeyword *string

+ IrcNotifyPrefs *string

+ IrcPassword *string

+ IrcServer *string

+ IrcUsername *string

+ Parallel int

+ Reponame string

+ SSHKeys []*PublicSSHKey

+ Setup string

+ SlackAPIToken *string

+ SlackChannel *string

+ SlackNotifyPrefs *string

+ SlackSubdomain *string

+ SlackWebhookURL *string

+ Test string

+ Username string

+ VCSURL string

+ type PublicSSHKey struct

+ Fingerprint string

+ Hostname string

+ PublicKey string

+ type SSHUser struct

+ GithubID int

+ Login string

+ type Step struct

+ Actions []*Action

+ Name string

+ type TestMetadata struct

+ Classname string

+ File string

+ Message *string

+ Name string

+ Result string

+ RunTime float64

+ Source string

+ SourceType string

+ type User struct

+ Admin bool

+ AllEmails []string

+ AvatarURL string

+ BasicEmailPrefs string

+ Containers int

+ CreatedAt time.Time

+ DaysLeftInTrial int

+ GithubID int

+ GithubOauthScopes []string

+ GravatarID *string

+ HerokuAPIKey *string

+ LastViewedChangelog time.Time

+ Login string

+ Name *string

+ Parallelism int

+ Plan *string

+ Projects map[string]*UserProject

+ SelectedEmail *string

+ SignInCount int

+ TrialEnd time.Time

+ type UserProject struct

+ Emails string

+ OnDashboard bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL