circle

Documentation

Index

• func AddEnvVar(apiToken string, projectSlug string, name string, value string) error
• func ApproveJob(apiToken string, approvalRequestID string, workFlowID string) (string, error)
• func CancelWorkflow(apiToken string, workflowID string) (circleci.MessageResponse, error)
• func DelEnvVar(apiToken string, projectSlug string, name string) error
• func EnvVarExists(apiToken string, projectSlug string, name string) (circleci.EnvironmentVariablePair, bool, error)
• func GetAllMyPipelinesForProject(apiToken string, projectSlug string) ([]circleci.Pipeline1, error)
• func GetAllPipelinesForProject(apiToken string, projectSlug string) ([]circleci.Pipeline1, error)
• func GetCurrentUser(apiToken string) (*circleci.User, error)
• func GetEnvVarsList(apiToken string, projectSlug string) ([]circleci.EnvironmentVariablePair1, error)
• func GetNameByID(apiToken string, id string) (string, error)
• func GetPipelineByID(apiToken string, pipelineID string) (circleci.Pipeline, error)
• func GetPipelineByNum(apiToken string, projectSlug string, num string) (circleci.Pipeline, error)
• func GetRecentlyBuiltPipelines(apiToken string, orgSlug string, mine bool) ([]circleci.Pipeline1, error)
• func GetWorkflow(apiToken string, workflowID string) (*circleci.Workflow, error)
• func GetWorkflowJobs(apiToken string, workflowID string) (*[]circleci.Job, error)
• func GetWorkflowJobsMetrics(apiToken string, projectSlug string, workflowName string) ([]circleci.InlineResponse2002Items, error)
• func GetWorkflowMetrics(apiToken string, projectSlug string) ([]circleci.InlineResponse200Items, error)
• func GetWorkflowsByPipeline(apiToken string, pipelineID string) ([]circleci.Workflow1, error)
• func RerunWorkflow(apiToken string, workflowID string) (circleci.MessageResponse, error)
• func TriggerPipeline(apiToken string, projectSlug string, params circleci.TriggerPipelineParameters) (circleci.PipelineCreation, error)

Functions

func AddEnvVar

func AddEnvVar(apiToken string, projectSlug string, name string, value string) error

AddEnvVar add an environment variable for given project

func ApproveJob

func ApproveJob(apiToken string, approvalRequestID string, workFlowID string) (string, error)

ApproveJob approves the pending job in the workflow

func CancelWorkflow

func CancelWorkflow(apiToken string, workflowID string) (circleci.MessageResponse, error)

CancelWorkflow cancels a given workflow

func DelEnvVar

func DelEnvVar(apiToken string, projectSlug string, name string) error

DelEnvVar delete an environment variable for given project

func EnvVarExists

func EnvVarExists(apiToken string, projectSlug string, name string) (circleci.EnvironmentVariablePair, bool, error)

EnvVarExists check if given env var exists

func GetAllMyPipelinesForProject

func GetAllMyPipelinesForProject(apiToken string, projectSlug string) ([]circleci.Pipeline1, error)

GetAllMyPipelinesForProject get all pipelines triggered by you

func GetAllPipelinesForProject

func GetAllPipelinesForProject(apiToken string, projectSlug string) ([]circleci.Pipeline1, error)

GetAllPipelinesForProject get all pipelines for a given project

func GetCurrentUser

func GetCurrentUser(apiToken string) (*circleci.User, error)

GetCurrentUser returns the current user

func GetEnvVarsList

func GetEnvVarsList(apiToken string, projectSlug string) ([]circleci.EnvironmentVariablePair1, error)

GetEnvVarsList returns list of environment variables for given projects

func GetNameByID

func GetNameByID(apiToken string, id string) (string, error)

GetNameByID returns username from user ID

func GetPipelineByID

func GetPipelineByID(apiToken string, pipelineID string) (circleci.Pipeline, error)

GetPipelineByID get info about single pipeline

func GetPipelineByNum

func GetPipelineByNum(apiToken string, projectSlug string, num string) (circleci.Pipeline, error)

GetPipelineByNum get info about single pipeline

func GetRecentlyBuiltPipelines

func GetRecentlyBuiltPipelines(apiToken string, orgSlug string, mine bool) ([]circleci.Pipeline1, error)

GetRecentlyBuiltPipelines get all recently built pipelines in a organization

func GetWorkflow

func GetWorkflow(apiToken string, workflowID string) (*circleci.Workflow, error)

GetWorkflow returns the info for given workflow ID

func GetWorkflowJobs

func GetWorkflowJobs(apiToken string, workflowID string) (*[]circleci.Job, error)

GetWorkflowJobs returns the info of jobs for given workflow ID

func GetWorkflowJobsMetrics

func GetWorkflowJobsMetrics(apiToken string, projectSlug string, workflowName string) ([]circleci.InlineResponse2002Items, error)

GetWorkflowJobsMetrics returns jobs metrics for given workflow

func GetWorkflowMetrics

func GetWorkflowMetrics(apiToken string, projectSlug string) ([]circleci.InlineResponse200Items, error)

GetWorkflowMetrics returns workflow metrics for a project

func GetWorkflowsByPipeline

func GetWorkflowsByPipeline(apiToken string, pipelineID string) ([]circleci.Workflow1, error)

GetWorkflowsByPipeline get all workflows by pipeline ID

func RerunWorkflow

func RerunWorkflow(apiToken string, workflowID string) (circleci.MessageResponse, error)

RerunWorkflow reruns a given workflow

func TriggerPipeline

func TriggerPipeline(apiToken string, projectSlug string,
	params circleci.TriggerPipelineParameters) (circleci.PipelineCreation, error)

TriggerPipeline triggers pipeline for given project and given branch/tag