pubbrew

type BaseSnapshot struct {
	// Branch is the tap's current default branch.
	Branch BranchName
	// Commit is the default branch head commit.
	Commit CommitSHA
	// File is the cask at Commit.
	File File
}

type BlobSHA string

type BranchName string

type BranchSnapshot struct {
	// Present reports whether the branch exists.
	Present bool
	// Commit is the branch head commit when Present is true.
	Commit CommitSHA
	// Parent is the sole parent of Commit. It is empty unless Commit has
	// exactly one parent.
	Parent CommitSHA
	// Files are the paths changed by Commit.
	Files []ChangedFile
	// File is the cask at Commit.
	File File
}

type CaskToken string

type ChangeStatus string

type ChangedFile struct {
	// Path is the repository-relative changed path.
	Path FilePath
	// Status is the GitHub change classification.
	Status ChangeStatus
}

type CommitSHA string

type File struct {
	// Present reports whether the path exists at the observed ref.
	Present bool
	// Content is the decoded file body when Present is true.
	Content []byte
	// SHA is the blob object ID when Present is true.
	SHA BlobSHA
}

type FilePath string

type PublicationState string

type PublishInput struct {
	// Tap is the Homebrew tap repository to update.
	Tap Repository
	// Source is the producer repository that owns the release.
	Source Repository
	// Version is the stable released version.
	Version rel.Version
	// Commit is the producer commit that built the release.
	Commit CommitSHA
	// Cask is the expected cask token and filename stem.
	Cask CaskToken
	// Content is the generated cask Ruby source.
	Content []byte
	// Sleep waits between retryable observations. Nil selects a
	// context-aware timer.
	Sleep SleepFunc
}

type PublishResult struct {
	// Tap is the target owner/repository.
	Tap string `json:"tap"`
	// Cask is the published cask token.
	Cask string `json:"cask"`
	// Branch is the deterministic publication branch.
	Branch string `json:"branch"`
	// PullRequestURL is the review URL. It can be empty when matching content
	// reached the default branch outside a discoverable pull request.
	PullRequestURL string `json:"pull_request_url"`
	// State is created, open, or published.
	State PublicationState `json:"state"`
}

type PullRequest struct {
	// State is the observed pull-request lifecycle.
	State PullRequestState
	// URL is the human-facing pull-request URL when State is not absent.
	URL string
}

type PullRequestInput struct {
	// Base is the tap default branch.
	Base BranchName
	// Head is the publication branch.
	Head BranchName
	// Title is the pull-request title.
	Title string
	// Body is the pull-request description.
	Body string
}

type PullRequestState string

type Repository struct {
	// Owner is the repository owner or organization.
	Owner string
	// Name is the repository name.
	Name string
}

type RepositoryReader interface {
	// ReadBase returns the default branch, its head, and path at that head.
	ReadBase(ctx context.Context, repository Repository, path FilePath) (BaseSnapshot, error)
	// ReadBranch returns branch head metadata and path at that head. An absent
	// branch is a successful snapshot with Present false.
	ReadBranch(
		ctx context.Context,
		repository Repository,
		branch BranchName,
		path FilePath,
	) (BranchSnapshot, error)
	// ReadPullRequest returns the unique pull request from head into base. No
	// match is a successful result with State absent.
	ReadPullRequest(
		ctx context.Context,
		repository Repository,
		base BranchName,
		head BranchName,
	) (PullRequest, error)
}

type RepositoryWriter interface {
	// CreateBranch creates branch at from without updating an existing ref.
	CreateBranch(
		ctx context.Context,
		repository Repository,
		branch BranchName,
		from CommitSHA,
	) error
	// PutFile creates one commit on branch that creates or replaces path.
	// Previous is empty for a new path and the current base blob for an update.
	PutFile(
		ctx context.Context,
		repository Repository,
		branch BranchName,
		path FilePath,
		previous BlobSHA,
		content []byte,
		message string,
	) error
	// CreatePullRequest opens a non-draft pull request without auto-merge.
	CreatePullRequest(
		ctx context.Context,
		repository Repository,
		input PullRequestInput,
	) (string, error)
}

type SleepFunc func(ctx context.Context, delay time.Duration) error