reposetup

type CIFields struct {
	Generate                *bool  `yaml:"generate"`
	ReleaseWorkflow         string `yaml:"releaseWorkflow"`
	AppCatalog              string `yaml:"appCatalog"`
	AppCatalogTest          string `yaml:"appCatalogTest"`
	ChartName               string `yaml:"chartName"`
	OverrideChartAppVersion *bool  `yaml:"overrideChartAppVersion"`
	ForcePublic             bool   `yaml:"forcePublic"`
	Image                   *struct {
		PreBuildJob     string            `yaml:"preBuildJob"`
		PrivateOnly     bool              `yaml:"privateOnly"`
		Name            string            `yaml:"name"`
		Platforms       string            `yaml:"platforms"`
		Dockerfile      string            `yaml:"dockerfile"`
		NativeBuilds    bool              `yaml:"nativeBuilds"`
		ResourceClasses map[string]string `yaml:"resourceClasses"`
	} `yaml:"image"`
	BranchPublish    bool   `yaml:"branchPublish"`
	SkipAppCatalog   bool   `yaml:"skipAppCatalog"`
	SkipATS          bool   `yaml:"skipATS"`
	ATSOnRelease     bool   `yaml:"atsOnRelease"`
	ATSVersion       string `yaml:"atsVersion"`
	ATSResourceClass string `yaml:"atsResourceClass"`
	BuildConcurrency string `yaml:"buildConcurrency"`
	ResourceClass    string `yaml:"resourceClass"`
	Go               *struct {
		TestArtifacts string `yaml:"testArtifacts"`
	} `yaml:"go"`
	Node *struct {
		TestTarget  string `yaml:"testTarget"`
		BuildTarget string `yaml:"buildTarget"`
		BuildOutput string `yaml:"buildOutput"`
	} `yaml:"node"`
}

type Creation struct {
	Name          string
	ComponentType string
	Description   string
	Visibility    string
	Flavours      []string
	Language      string
}

type Declaration struct {
	// Name is the entry's name field; empty when the entry has none.
	Name string
	// contains filtered or unexported fields
}

type DirTemplates struct {
	Root string
}

type Entry struct {
	// Name of the repository.
	Name string `json:"name"`
	// Rendered is the entry as it would be written to the team file, defaults
	// applied (gen.ci.generate: true), as a one-item YAML list.
	Rendered string `json:"rendered"`
	// Template the repository would be scaffolded from; empty when the
	// declaration does not derive one.
	Template Template `json:"template,omitempty"`
	// Options the template's scaffold offers, selected by name through
	// [RenderRequest.Options]; nil when the template has none.
	Options []Option `json:"options,omitempty"`
	// NameCheck is the verdict of the GitHub name check.
	NameCheck NameCheck `json:"nameCheck"`
	// Problems are the refusals, each naming the field. Empty when accepted.
	Problems []Problem `json:"problems,omitempty"`
	// Accepted is true when the entry has no problems.
	Accepted bool `json:"accepted"`
}

type Fields struct {
	Name           string   `yaml:"name"`
	ComponentType  string   `yaml:"componentType"`
	Description    string   `yaml:"description"`
	Visibility     string   `yaml:"visibility"`
	Lifecycle      string   `yaml:"lifecycle"`
	ChoreReviewers []string `yaml:"choreReviewers"`
	Replace        *struct {
		Precommit bool `yaml:"precommit"`
	} `yaml:"replace"`
	Gen *GenFields `yaml:"gen"`
}

type FileGetter interface {
	GetFile(ctx context.Context, owner, repo, path, ref string) (githubclient.RepositoryFile, error)
}

type GenFields struct {
	Flavours                      []string  `yaml:"flavours"`
	Language                      string    `yaml:"language"`
	InstallUpdateChart            bool      `yaml:"installUpdateChart"`
	HelmDocsRegen                 bool      `yaml:"helmDocsRegen"`
	RunSecurityScorecard          *bool     `yaml:"runSecurityScorecard"`
	GenerateLlmRules              *bool     `yaml:"generateLlmRules"`
	GoGenerate                    bool      `yaml:"goGenerate"`
	PreCommit                     []string  `yaml:"preCommit"`
	EnableUpstreamSyncAutomation  bool      `yaml:"enableUpstreamSyncAutomation"`
	DispatchUpdateChartEventsRepo string    `yaml:"dispatchUpdateChartEventsRepo"`
	CI                            *CIFields `yaml:"ci"`
}

type GitHubNameChecker struct {
	Repositories RepositoryGetter
}

type GitHubTemplates struct {
	// Ref is the branch or tag; default main.
	Ref string
	// Token authenticates the download. giantswarm/template is private, so
	// the Go template needs it (GitHub answers 404 without); for the public
	// templates it raises the rate limit.
	Token string
	// Client is the HTTP client; default [http.DefaultClient].
	Client *http.Client
}

type Mode string

type NameCheck struct {
	Verdict Verdict `json:"verdict"`
	Detail  string  `json:"detail,omitempty"`
}

type NameChecker interface {
	CheckName(ctx context.Context, owner, name string) (NameCheck, error)
}

type Notice struct {
	Kind    NoticeKind `json:"kind"`
	Message string     `json:"message"`
}

type NoticeKind string

type Option struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Values      []string `json:"values,omitempty"`
	Default     string   `json:"default,omitempty"`
}

type Person struct {
	Login string
	Teams []string
}

type Problem struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

type PullRequest struct {
	// Branch is the head branch to create; it must not exist.
	Branch string
	// Path and Content are the file and its new text; SHA is the blob SHA
	// the file has at Ref, so the write is refused when it moved.
	Path    string
	Content []byte
	SHA     string
	// CommitMessage, Title and Body are the commit's and the pull
	// request's.
	CommitMessage, Title, Body string
}

type Remote struct {
	// GitHub is the client; required.
	GitHub *github.Client
	// Owner, Repo and Ref locate the team files; empty means
	// giantswarm/github at main.
	Owner, Repo, Ref string
}

type RemoteTeamFile struct {
	*TeamFile
	// SHA is the blob's SHA at Ref.
	SHA string
	// Content is the file's text at Ref.
	Content []byte
}

type RenderRequest struct {
	// Team is the slug of the team file the entry lives in (team-bumblebee):
	// CODEOWNERS names it and the chart's team annotation carries its short
	// name.
	Team string
	// Entry is an accepted entry of [Validator.Validate]; its Rendered
	// declaration and Template are read.
	Entry Entry
	// Dir is the directory the scaffold is rendered into. It is created;
	// an existing directory has to be empty.
	Dir string
	// Options selects among [Entry.Options] by name; an option left out
	// takes its default.
	Options map[string]string
}

type Renderer struct {
	// Templates fetches the template repositories; nil fetches the tarball
	// of each template's main branch from GitHub ([GitHubTemplates]).
	Templates TemplateSource
	// Log receives the generators' output; nil discards it.
	Log io.Writer
}

type RepositoryGetter interface {
	GetRepository(ctx context.Context, owner, repo string) (*github.Repository, error)
}

type Request struct {
	// TeamFile the entries live in; its team is the owning team. Required.
	TeamFile *TeamFile
	// Names of the entries to validate. Nil means every entry of the file.
	Names []string
	// Mode says what the entries are validated for: [ModeCreate] applies the
	// creation rules to entries being added, [ModeExisting] the schema alone
	// to entries whose repositories exist. Empty means ModeCreate.
	Mode Mode
	// Author is the GitHub login of the person opening the change; empty
	// when unknown, which skips the team guard.
	Author string
	// AuthorTeams are the GitHub team slugs the author is a member of
	// (team-bumblebee; a giantswarm/ or @giantswarm/ prefix is accepted).
	AuthorTeams []string
}

type Result struct {
	// Team that owns the entries: the team file's.
	Team string `json:"team"`
	// Mode the entries were validated in.
	Mode Mode `json:"mode"`
	// Schema the entries were validated against.
	Schema SchemaOrigin `json:"schema"`
	// Entries in request order.
	Entries []Entry `json:"entries"`
	// Notices are the guard notices that apply to the change as a whole.
	Notices []Notice `json:"notices,omitempty"`
	// Accepted is true when every entry is accepted.
	Accepted bool `json:"accepted"`
}

type Scaffold struct {
	// Dir the scaffold was rendered into.
	Dir string `json:"dir"`
	// Template it was rendered from.
	Template Template `json:"template"`
	// Options in effect, defaults included.
	Options map[string]string `json:"options,omitempty"`
	// Commands are the `devctl gen …` command lines that produced the
	// generated files, as align-files runs them.
	Commands []string `json:"commands"`
	// Files are the scaffold's paths relative to Dir, sorted.
	Files []string `json:"files"`
}

type Schema struct {
	Origin SchemaOrigin
	// contains filtered or unexported fields
}

type SchemaOrigin string

type TeamFile struct {
	// Team is the GitHub team slug the file belongs to: the file's base name
	// without extension (repositories/team-bumblebee.yaml → team-bumblebee).
	Team string
	// Path is where the file was read from; empty for a parsed reader.
	Path string
	// Entries in file order.
	Entries []Declaration
}

type Template string

type TemplateSource interface {
	// Fetch writes the tree of the template repository (owner/name) into
	// dir, which exists and is empty.
	Fetch(ctx context.Context, repository, dir string) error
}

type Undeclared struct {
	// Name of the repository. Required.
	Name string
	// ComponentType of the catalog; left out of the entry when empty.
	ComponentType string
	// Lifecycle is the declared lifecycle (archived); left out when empty.
	Lifecycle string
}

type Validator struct {
	// Schema the entries are validated against. Required.
	Schema *Schema
	// Names checks whether a repository name is free on GitHub. Optional:
	// without one every name is reported unchecked and the result says so.
	Names NameChecker
	// Owner is the GitHub organisation; DefaultOwner when empty.
	Owner string
}

type Verdict string