Documentation
¶
Index ¶
Constants ¶
const ContinuationOrbVersion = "2.0.1"
ContinuationOrbVersion pins the circleci/continuation orb used by the generated setup config (.circleci/config.yml) to merge the optional repo-owned .circleci/custom.yml into .circleci/workflows.yml at pipeline runtime. Baked in for the same reason as OrbVersion: a bump ships with a devctl release and reaches repos via align-files.
renovate: datasource=orb depName=circleci/continuation
const OrbVersion = "9.4.1"
OrbVersion is the aligned giantswarm/architect orb version every generated CircleCI config pins. It is baked in next to the template -- not a flag and not passed in by callers -- so that an orb bump (which can change the template's required job/param shape, i.e. a cross-major compatibility contract) forces a new devctl release rather than silently combining a stale template with a newer orb at generation time.
Renovate keeps this current; a major bump lands as a devctl PR, gets released, and only then reaches repos via the align-files devctl pin.
renovate: datasource=orb depName=giantswarm/architect
Variables ¶
This section is empty.
Functions ¶
func IsInvalidConfig ¶
IsInvalidConfig asserts invalidConfigError.
Types ¶
type CircleCI ¶
type CircleCI struct {
// contains filtered or unexported fields
}
func (*CircleCI) SetupConfig ¶ added in v8.11.0
SetupConfig is the static dynamic-config setup workflow written to .circleci/config.yml. It merges the optional repo-owned custom.yml into workflows.yml at pipeline runtime.
type Config ¶
type Config struct {
// RepoName is the repository name, used for the binary, chart, and job
// names.
RepoName string
// Language is the repo language. "go" selects the go-build job.
Language gen.Language
// Flavours are the devctl gen flavours. The "app" flavour selects the
// chart pipeline.
Flavours gen.FlavourSlice
// HasDockerfile selects the image pipeline. The runner derives this from
// the presence of a Dockerfile in the repo.
HasDockerfile bool
// BranchPublish opts the repo into publishing a dev image and chart on
// branch builds. By default branches build + test only (no push). When
// set, the branch path additionally pushes an amd64 dev image and the
// dev chart, coupled (both or neither).
BranchPublish bool
}
Source Files
Directories