circleci

Documentation

Index

• type Config
• type Docker
• type Job
• type Run
• type Step
• type Workflow

Types

type Config

type Config struct {
	// Version specifies the yaml configuration
	// file version.
	Version string

	// Jobs defines a list of pipeline jobs.
	Jobs []*Job

	// Workflows are used to orchestrate jobs.
	Workflows struct {
		Version string
		List    map[string]*Workflow `yaml:",inline"`
	}
}

Config defines the pipeline configuration.

type Docker

type Docker struct {
	// Image is the Docker image name.
	Image string

	// Name is the Docker container hostname.
	Name string

	// Entrypoint is the Docker container entrypoint.
	Entrypoint []string

	// Command is the Docker container command.
	Command []string

	// User is user that runs the Docker entrypoint.
	User string

	// Environment variables passed to the container.
	Environment map[string]string

	// Auth credentials to pull private images.
	Auth map[string]string

	// Auth credentials to pull private ECR images.
	AWSAuth map[string]string `yaml:"aws_auth"`
}

Docker configures a Docker executor.

type Job

type Job struct {
	// Name of the stage.
	Name string

	// Docker configures a Docker executor.
	Docker Docker

	// Environment variables passed to the executor.
	Environment map[string]string

	// Steps configures the Job steps.
	Steps map[string]Step

	// Branches limits execution by branch.
	Branches []struct {
		Only   []string
		Ignore []string
	}
}

Job defines a pipeline job.

type Run

type Run struct {
	// Name of the command
	Name string

	// Command run in the shell.
	Command string

	// Shell to use to execute the command.
	Shell string

	// Workiring Directory in which the command
	// is run.
	WorkingDir string `yaml:"working_directory"`

	// Command is run in the background.
	Background bool `yaml:"background"`

	// Amount of time the command can run with
	// no output before being canceled.
	NoOutputTimeout time.Duration `yaml:"no_output_timeout"`

	// Environment variables set when running
	// the command in the shell.
	Environment map[string]string

	// Defines when the command should be executed.
	// Values are always, on_success, and on_fail.
	When string
}

Run defines a command

type Step

type Step struct {
	Run                Run
	AddSSHKeys         map[string]interface{} `yaml:"add_ssh_keys"`
	AttachWorkspace    map[string]interface{} `yaml:"attach_workspace"`
	Checkout           map[string]interface{} `yaml:"checkout"`
	Deploy             map[string]interface{} `yaml:"deploy"`
	PersistToWorkspace map[string]interface{} `yaml:"persist_to_workspace"`
	RestoreCache       map[string]interface{} `yaml:"restore_cache"`
	SaveCache          map[string]interface{} `yaml:"save_cache"`
	SetupRemoteDocker  map[string]interface{} `yaml:"setup_remote_docker"`
	StoreArtifacts     map[string]interface{} `yaml:"store_artifacts"`
	StoreTestResults   map[string]interface{} `yaml:"store_test_results"`
}

Step defines a build execution unit.

type Workflow

type Workflow struct {
	Jobs []string
}

Workflow ochestrates one or more jobs.