reposetup

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

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"`
	// 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 FileGetter interface {
	GetFile(ctx context.Context, owner, repo, path, ref string) (githubclient.RepositoryFile, error)
}

type GitHubNameChecker struct {
	Repositories RepositoryGetter
}

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 Problem struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

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 being added, the ones the creation rules apply
	// to. Nil means every entry of the file.
	Names []string
	// 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"`
	// 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 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 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