circleci

type CircleCI struct {
	// contains filtered or unexported fields
}

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
	// SkipATS opts the chart pipeline out of app-test-suite (ATS) chart tests.
	// When set, the run-tests-with-ats jobs and the canonical tests/ats/Pipfile
	// are not generated, and the chart push jobs gate directly on build-chart.
	// Only applies to a chart/app repo (the "app" flavour).
	SkipATS bool
	// HasDockerfile selects the image pipeline. The runner derives this from
	// the presence of a Dockerfile in the repo.
	HasDockerfile bool
	// AppCatalog overrides the catalog the chart pipeline publishes to. Empty
	// defaults to "giantswarm-catalog". Set it for repos that ship to a
	// different catalog (e.g. the internal "giantswarm-operations-platform")
	// so generation does not migrate their chart to the public catalog.
	AppCatalog string
	// AppCatalogTest overrides the test catalog. Empty defaults to
	// "giantswarm-test-catalog". Kept paired with AppCatalog.
	AppCatalogTest string
	// ChartName overrides the chart name (the push-to-app-catalog `chart`
	// param and the helm/<chart> directory). Empty defaults to RepoName. Set it
	// for repos whose chart directory does not match the repo name (e.g.
	// docs-proxy ships helm/docs-proxy-app).
	ChartName string
	// OverrideChartAppVersion decides whether app-build-suite stamps the
	// computed build version into the chart's appVersion. nil derives it from
	// the repo's shape: a repo that builds its own image ships the app it
	// packages, so its appVersion is its own version and is stamped; a
	// chart-only repo packages an app built elsewhere, so the appVersion
	// declared in Chart.yaml is kept. A non-nil value overrules that in either
	// direction. The append-only custom.yml merge cannot add a param to a
	// generated job, so the generator carries it.
	OverrideChartAppVersion *bool
	// ForcePublic pushes the image and chart as public artifacts even though
	// the repo is private (architect force-public: true). Set it for private
	// repos that publish public artifacts (e.g. web-assets). Mutually exclusive
	// with ImagePrivateOnly.
	ForcePublic 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
	// ImagePreBuildJob names a repo-owned custom.yml job the image build must
	// wait on (adds a `requires` entry to push-to-registries-release and the
	// branch build-image / push-to-registries job). Used for workspace-handoff
	// pre-steps the append-only custom.yml merge cannot inject into a generated
	// job. Empty for the common case.
	ImagePreBuildJob string
	// ImageDockerfile overrides the Dockerfile path on the image jobs (the
	// architect push-to-registries `dockerfile` param). A non-empty value also
	// forces the image pipeline on, so a repo whose Dockerfile is not at the
	// repo root (e.g. backstage -> packages/backend/Dockerfile) still generates
	// image jobs. Empty keeps the orb default ("Dockerfile") and leaves the
	// root-Dockerfile derivation untouched.
	ImageDockerfile string
	// ImagePrivateOnly ships the image to the private registry only
	// (gsociprivate), replacing split-china-push and omitting sync-china-registry.
	// Set it for private repos whose image must not land in the public catalog.
	ImagePrivateOnly bool
	// ImageName overrides the `giantswarm/<repo>` default image name on the
	// image jobs. Set it for repos whose published image differs from the repo
	// name (e.g. kserve -> giantswarm/kserve-controller). Empty keeps the orb
	// default.
	ImageName string
	// ImagePlatforms overrides the buildx platform list on the image jobs.
	// Empty lets the orb default apply. Set it for single-architecture images
	// (e.g. vllm -> linux/arm64).
	ImagePlatforms string
	// BuildConcurrency overrides how many architectures the cli-flavour
	// go-build job compiles concurrently (the architect go-build
	// `build_concurrency` param). Empty defaults to "auto" (nproc). Lower it
	// (e.g. "2") for repos whose binary is large enough that a cold full-matrix
	// cross-compile OOMs the runner at `auto` -- memory, not CPU, is the binding
	// constraint, and a killed build never stores the build cache, so the repo
	// stays permanently cold. Only applies to the cli flavour (ReleaseBinaries).
	BuildConcurrency string
	// ResourceClass overrides the CircleCI resource_class on the cli-flavour
	// go-build job. Empty defaults to "large". Raise it (e.g. "xlarge") for
	// repos that need more RAM/CPU headroom for the cold cross-compile. Only
	// applies to the cli flavour (ReleaseBinaries).
	ResourceClass string
	// PackageManager selects the Node package manager the build/test job uses
	// (one of "npm", "yarn", "yarn-classic", "pnpm"). The runner detects it
	// from the lockfile; empty defaults to Yarn Berry. Only applies to a Node
	// repo (Language == "node").
	PackageManager string
	// NodeImageVersion pins the cimg/node tag the build/test job runs on, and
	// with it the node-build cache-key salt. The runner detects it from the
	// repo's .nvmrc; empty falls back to DefaultNodeImageVersion. Only applies
	// to a Node repo (Language == "node").
	NodeImageVersion string
	// NodeTestTarget overrides the package.json script the Node job runs for
	// the verify phase (ci:verify). Empty defaults to "test". The repo composes
	// its entire correctness gate -- tsc --noEmit + lint + prettier --check +
	// unit tests, in one process -- into this one script (the make-target
	// interface). The default "test" is only a floor; the convention is an
	// explicit composed ci:verify. Only applies to a Node repo.
	NodeTestTarget string
	// NodeBuildTarget is the package.json script the Node job runs to build
	// (ci:build). Empty omits the build step (a library that only verifies).
	// It must be bundle/emit-only -- it must redo nothing NodeTestTarget already
	// did (no second typecheck/lint/test) and must not re-install. Only applies
	// to a Node repo.
	NodeBuildTarget string
	// NodeBuildOutput is the workspace path the Node job persists for an image
	// handoff (e.g. backstage's "packages/*/dist/*"). Non-empty names the job
	// "node-build" and emits persist_to_workspace; empty names it "node-test".
	// Only applies to a Node repo.
	NodeBuildOutput string
}