params

type ImageBuild struct {
	// Name is the CircleCI job name, e.g. "build-image-arm64". Branch and tag
	// paths need distinct names because both appear in the same workflow.
	Name string
	// Platform is the buildx platform, e.g. "linux/arm64".
	Platform string
	// ResourceClass is a CircleCI class whose architecture matches Platform.
	// CircleCI gives the setup_remote_docker VM the architecture of the job's
	// class, so this is what decides whether the build is native or emulated.
	ResourceClass string
}

type Params struct {
	// RepoName is the repository name. It is used for the Go binary, the
	// Helm chart, and the architect job names.
	RepoName string
	// Language is the repo language (e.g. "go"). "go" selects the go-build
	// job.
	Language string
	// HasDockerfile is true when the repo ships a Dockerfile. It selects the
	// image pipeline (push-to-registries with split-china-push and the
	// paired sync-china-registry job).
	HasDockerfile bool
	// HasApp is true when the repo carries the "app" flavour (at least one
	// Helm chart). It selects the chart pipeline (push-to-app-catalog with the
	// app-build-suite executor and run-tests-with-ats).
	HasApp bool
	// SkipATS opts the chart pipeline out of app-test-suite (ATS) chart tests.
	// When true the run-tests-with-ats jobs (execute-chart-tests /
	// execute-chart-tests-release) and the canonical tests/ats/Pipfile are not
	// emitted, and the chart push jobs gate directly on build-chart instead.
	// Only meaningful for a chart/app repo (HasApp); ignored otherwise.
	SkipATS bool
	// ATSOnRelease adds the tag-time chart-test job (execute-chart-tests-release,
	// gating push-chart-release) next to the branch job. False, the default,
	// runs the chart tests on branches only and lets the tag build and push
	// the chart straight after build-chart: the tag is cut from the merge
	// commit of a PR whose branch run already tested that tree. Mutually
	// exclusive with SkipATS. Only meaningful for a chart/app repo (HasApp);
	// ignored otherwise.
	ATSOnRelease bool
	// ATSVersion is the app-test-suite container tag emitted as
	// `app-test-suite_container_tag` on both run-tests-with-ats jobs. Empty
	// emits nothing and the orb default applies.
	ATSVersion string
	// ATSKindCluster emits `create_kind_cluster: true` on both
	// run-tests-with-ats jobs (app-test-suite 1.x: the job creates the kind
	// cluster) and selects the uv layout of the generated test dependencies
	// (tests/ats/pyproject.toml + uv.lock instead of tests/ats/Pipfile). Derived
	// from ATSVersion (major >= 1).
	ATSKindCluster bool
	// ATSKindConfig is the repo-owned kind Cluster configuration emitted as
	// `kind_config` on both run-tests-with-ats jobs (the job passes it to
	// `kind create cluster --config`: feature gates, runtime config, patches,
	// extra nodes). Set to the conventional path when the repo carries the
	// file; empty emits nothing and the job creates the cluster as before.
	ATSKindConfig string
	// ATSResourceClass is the CircleCI resource_class emitted on both
	// run-tests-with-ats jobs (medium, large, xlarge, 2xlarge). Empty emits
	// nothing and the orb default (medium) applies.
	ATSResourceClass string
	// ChartName is the chart name used for the push-to-app-catalog `chart`
	// param and the helm/<chart> directory. 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). The append-only custom.yml merge
	// cannot rename a generated job's chart, so the generator carries it.
	ChartName string
	// KeepChartAppVersion emits the push-to-app-catalog
	// `override_app_version: false` param, so app-build-suite keeps the
	// appVersion declared in Chart.yaml. Already resolved by the generator: it
	// is true for a chart-only repo (the chart packages an app built elsewhere)
	// and false for a repo that builds its own image, unless
	// Config.OverrideChartAppVersion overruled that. Only meaningful for a
	// chart/app repo (HasApp); ignored otherwise.
	KeepChartAppVersion bool
	// ForcePublic pushes the image and chart as public artifacts even though
	// the repo is private (architect `force-public: true` on push-to-registries
	// and push-to-app-catalog). Set it for private repos that publish public
	// artifacts (e.g. web-assets); architect otherwise derives private from the
	// repo visibility. Mutually exclusive with ImagePrivateOnly.
	ForcePublic bool
	// AppCatalog is the catalog the chart pipeline publishes to (the
	// push-to-app-catalog `app_catalog` param). Defaults to "giantswarm-catalog".
	// Repos that ship to a different catalog (e.g. the internal
	// "giantswarm-operations-platform") set it so generation does not silently
	// migrate their chart to the public catalog.
	AppCatalog string
	// AppCatalogTest is the test catalog the chart pipeline publishes to (the
	// push-to-app-catalog `app_catalog_test` param). Defaults to
	// "giantswarm-test-catalog". Kept paired with AppCatalog.
	AppCatalogTest string
	// BranchPublish is true when the repo opts into publishing a dev image and
	// chart on branch builds. By default branches build + test only; when set,
	// the branch path additionally pushes an amd64 dev image and the dev chart
	// (coupled).
	BranchPublish bool
	// ImagePreBuildJob names a repo-owned job (defined in .circleci/custom.yml)
	// that the release image build must wait on. The generated
	// push-to-registries-release job gains a `requires` entry for it, which the
	// append-only custom.yml merge cannot inject into a generated job. Used for
	// workspace-handoff pre-steps (e.g. a job that persists a generated file the
	// Docker build context overlays via attach_workspace). The branch
	// build-image (and branch-publish push-to-registries) job gains the same
	// `requires` entry, so the branch image validation also gets the workspace.
	// Empty for the common case.
	ImagePreBuildJob string
	// ImagePrivateOnly is true when the repo's image must ship only to the
	// private registry (gsociprivate). It replaces the default split-china-push
	// (which also publishes the public gsoci copy and mirrors to Aliyun) with an
	// explicit private-only registries-data, and omits the sync-china-registry
	// job. Set it for private repos whose image must not land in the public
	// catalog.
	ImagePrivateOnly bool
	// ImageName overrides the `giantswarm/<repo>` default the architect orb
	// derives for the published image (the push-to-registries / sync-china-registry
	// `image` param). Set it for repos whose image name differs from the repo
	// name (e.g. kserve publishes `giantswarm/kserve-controller`). The
	// append-only custom.yml merge cannot rename a generated job's image, so the
	// generator carries it. Empty keeps the orb default.
	ImageName string
	// ImagePlatforms overrides the buildx platform list for the image build
	// (the push-to-registries `platforms` param on the build-image and
	// push-to-registries-release jobs). Empty lets the orb fall back to its
	// default (linux/amd64,linux/arm64 when no go-build .platforms file). Set it
	// for repos whose image targets a single architecture (e.g. vllm ships an
	// arm64-only image for DGX Spark; an amd64 build has no prebuilt wheels and
	// fails). The append-only custom.yml merge cannot cap a generated job's
	// platforms, so the generator carries it.
	ImagePlatforms string
	// ImageNativeBuilds selects the per-architecture image build: one
	// architect/build-image job per platform (BranchImageBuilds /
	// ReleaseImageBuilds), each on a resource class of that architecture, and
	// the push-to-registries jobs with `merge-digests: true`, joining the
	// recorded digests into the tagged index instead of building. False keeps
	// the single multi-platform buildx job. When true, ImagePlatforms is the
	// resolved list and must name exactly the platforms the build jobs cover --
	// the orb fails the merge in either direction rather than publishing an
	// index that is missing an architecture.
	ImageNativeBuilds bool
	// BranchImageBuilds and ReleaseImageBuilds are the per-architecture
	// build-image jobs of the branch and tag paths when ImageNativeBuilds is
	// set. One job per platform, each pinned to a resource class of that
	// platform's architecture, because a CircleCI job runs on one machine and a
	// machine is native for one architecture. Empty otherwise.
	BranchImageBuilds  []ImageBuild
	ReleaseImageBuilds []ImageBuild
	// ImageDockerfile overrides the Dockerfile path on the image jobs (the
	// architect push-to-registries `dockerfile` param). Set it for repos whose
	// Dockerfile is not at the repo root (e.g. backstage builds from
	// packages/backend/Dockerfile). A non-empty value also forces the image
	// pipeline on, since the root-Dockerfile derivation misses a nested
	// Dockerfile. The append-only custom.yml merge cannot set this on a
	// generated job, so the generator carries it. Empty keeps the orb default
	// ("Dockerfile").
	ImageDockerfile string
	// ReleaseBinaries is true when the repo distributes cross-platform Go
	// binaries on its GitHub Release (derived from the "cli" flavour on a Go
	// repo). It adds the six-platform architectures matrix to go-build and an
	// upload-release-assets job, and caps the multi-arch image push to
	// linux/amd64,linux/arm64 (otherwise buildx tries the darwin/windows
	// targets under QEMU and hangs).
	ReleaseBinaries bool
	// BuildConcurrency is the architect go-build `build_concurrency` value the
	// cli-flavour job renders (how many architectures compile concurrently).
	// Defaulted to "auto" by the generator for cli repos; empty for non-cli
	// repos, where the template omits the go-build resource block entirely.
	BuildConcurrency string
	// ResourceClass is the CircleCI resource_class the cli-flavour go-build job
	// renders. Defaulted to "large" by the generator for cli repos; empty for
	// non-cli repos.
	ResourceClass string
	// GoBuildPath is the architect go-build `path` param: the package the job
	// compiles. Empty omits the param so the orb default "." applies. Set for
	// Go repos whose main package lives in a subdirectory (e.g. ./cmd/coredns).
	GoBuildPath string
	// GoTestArtifacts is a directory under the checkout that `make test` (the
	// go-build test_target) writes and that the job keeps as a CircleCI build
	// artifact when it FAILS. Non-empty renders `post-steps` on the
	// architect/go-build job: a run step stages the directory when: on_fail
	// and store_artifacts uploads the staging directory, so a green run stores
	// nothing. Empty omits the post-steps. Set for repos whose test suite
	// writes a report the console output only shows a trimmed tail of (e.g.
	// muster's integration suite writes one JSON per scenario, with the
	// complete instance logs, to test-reports/). Normalized by the generator.
	GoTestArtifacts string
	// OrbVersion is the giantswarm/architect orb version to pin.
	OrbVersion string
	// ContinuationOrbVersion is the circleci/continuation orb version the
	// setup config pins.
	ContinuationOrbVersion string
	// BuildJobName is the build/test job the image and chart jobs gate on via
	// `requires` -- "go-build" for Go, "node-build"/"node-test" for Node. Empty
	// for languageless repos (the image/chart jobs then gate on nothing extra).
	BuildJobName string
	// NodeJobName is the generated Node job's name: "node-build" when it
	// persists a build output for an image handoff, "node-test" otherwise.
	// Empty for non-Node repos.
	NodeJobName string
	// NodeImageVersion is the cimg/node Docker tag the Node job runs on, taken
	// from the repo's .nvmrc when it pins one and from devctl's baked-in
	// default otherwise. It also salts NodeBuildCacheKey, so the image and the
	// cache it restores can never disagree.
	NodeImageVersion string
	// NodeInstallCommand installs dependencies for the detected package manager
	// (e.g. "npm ci", "yarn install --immutable").
	NodeInstallCommand string
	// NodeRunPrefix prefixes a package.json script invocation for the detected
	// package manager (e.g. "npm run", "yarn run").
	NodeRunPrefix string
	// NodeCachePath is the dependency cache directory for the detected package
	// manager (e.g. "~/.npm", ".yarn/cache").
	NodeCachePath string
	// NodeCacheKey is the full save_cache key, embedding the literal CircleCI
	// `{{ checksum "<lockfile>" }}` expression so the cache invalidates when the
	// lockfile changes.
	NodeCacheKey string
	// NodeCacheRestoreKey is the lockfile-agnostic restore_cache prefix, so a
	// changed lockfile still warm-starts from the last good cache.
	NodeCacheRestoreKey string
	// NodeBuildCachePaths is the build-output cache: the materialized
	// dependency tree (node_modules, Yarn install-state) holding compiled
	// native addons, so a warm run skips the node-gyp rebuild the dependency
	// (tarball) cache cannot avoid. Empty for npm/pnpm (see nodeToolchain).
	NodeBuildCachePaths []string
	// NodeBuildCacheKey is the full save_cache key for the build-output cache,
	// salted with the node image version (native ABI is node-version-specific)
	// and the lockfile checksum. Empty when NodeBuildCachePaths is empty.
	NodeBuildCacheKey string
	// NodeBuildCacheRestoreKey is the restore_cache prefix for the build-output
	// cache (node-image-versioned, lockfile-agnostic), so a changed lockfile
	// warm-starts from the previous node_modules and only reconciles the diff.
	NodeBuildCacheRestoreKey string
	// NodeCorepack is true when the package manager needs `corepack enable`
	// (pnpm, which cimg/node does not bundle).
	NodeCorepack bool
	// NodeResourceClass is the CircleCI resource_class the Node job runs on.
	// Defaults to "large"; raised per repo via gen.ci.resourceClass (the same
	// knob the cli go-build job uses) for a memory-hungry monorepo verify/build.
	NodeResourceClass string
	// NodeTestTarget is the package.json script the Node job runs for the
	// verify phase (the make-target interface). Defaults to "test".
	NodeTestTarget string
	// NodeBuildTarget is the package.json script the Node job runs to build.
	// Empty omits the build step.
	NodeBuildTarget string
	// NodeBuildOutput is the workspace path the Node job persists for an image
	// handoff (e.g. "packages/*/dist/*"). Empty omits persist_to_workspace.
	NodeBuildOutput string
	// TemplateChart is true for a chart repository whose componentType is
	// template: the chart at helm/{APP-NAME} carries placeholders, so the
	// chart job is an inline job that renders the checkout with fixture values
	// (the app name and Helm repository fixtures, the team from Team) and runs
	// app-build-suite on the rendered chart. The chart-test and chart push
	// jobs are not emitted: nothing is released from a template. Derived by
	// the generator from Config.ComponentType and the app flavour.
	TemplateChart bool
	// Team is the owning team's short name (honeybadger), rendered into the
	// template chart's team label. Empty unless TemplateChart.
	Team string
	// The template contract the render step spells out: the placeholders a
	// template carries and the fixture values two of them are rendered with
	// (the third is Team). Constants of the circleci package, passed through
	// like OrbVersion so the template and the generator name them in one place.
	TemplateAppNamePlaceholder        string
	TemplateTeamPlaceholder           string
	TemplateHelmRepositoryPlaceholder string
	TemplateAppName                   string
	TemplateHelmRepository            string
}