docspreview

type BlobWriter interface {
	CreateBlob(ctx context.Context, owner, repo string, content, encoding string) (string, error)
}

type BranchClient interface {
	GetRef(ctx context.Context, owner, repo, ref string) (Ref, error)
	CreateRef(ctx context.Context, owner, repo, ref, sha string) error
	UpdateRef(ctx context.Context, owner, repo, ref, sha string) error
	GetCommit(ctx context.Context, owner, repo, sha string) (Commit, error)
}

type BranchResult struct {
	Outcome  string
	Attempts int
}

type BranchTip struct {
	CommitSHA string
	TreeSHA   string
}

type CleanupClient interface {
	BranchClient
	TreeReader
	TreeWriter
	CommentClient
}

type CleanupOptions struct {
	Client CleanupClient
	Logger Logger
	Repo   Repository
	Event  Event
}

type Comment struct {
	ID   int64
	Body string
}

type CommentClient interface {
	ListComments(ctx context.Context, owner, repo string, issueNumber int) ([]Comment, error)
	UpdateComment(ctx context.Context, owner, repo string, commentID int64, body string) error
	CreateComment(ctx context.Context, owner, repo string, issueNumber int, body string) error
}

type Commit struct {
	SHA     string
	TreeSHA string
	Parents []string
	Message string
}

type CommitToBranchOptions struct {
	Client         BranchClient
	Logger         Logger
	Repo           Repository
	CreateIfAbsent bool
	MaxAttempts    int
	BuildCommit    func(context.Context, *BranchTip) (string, error)
}

type Event struct {
	Repository  EventRepository `json:"repository"`
	PullRequest *PullRequest    `json:"pull_request"`
}

type EventOwner struct {
	Login string `json:"login"`
	Name  string `json:"name"`
}

type EventRepository struct {
	FullName string     `json:"full_name"`
	Name     string     `json:"name"`
	Owner    EventOwner `json:"owner"`
}

type GitHubHTTPClient struct {
	Client  *http.Client
	BaseURL string
	Token   string
}

type Logger interface {
	Info(message string)
}

type PreviewEntry struct {
	Kind string `json:"kind"`
	File string `json:"file,omitempty"`
}

type PreviewManifest map[string]map[string]PreviewEntry

type PruneClient interface {
	BranchClient
	TreeReader
	TreeWriter
}

type PruneOptions struct {
	Client PruneClient
	Logger Logger
	Repo   Repository
	Now    time.Time
	MaxAge time.Duration
}

type PublishClient interface {
	BranchClient
	TreeWriter
	BlobWriter
	CommentClient
}

type PublishOptions struct {
	Client       PublishClient
	Logger       Logger
	Repo         Repository
	Event        Event
	ManifestPath string
	AssetsDir    string
	SHA          string
	RunID        string
	RunAttempt   string
	Now          time.Time
}

type PullBaseRef struct {
	Ref string `json:"ref"`
	SHA string `json:"sha"`
}

type PullRef struct {
	Repo *PullRepository `json:"repo"`
}

type PullRepository struct {
	FullName string `json:"full_name"`
}

type PullRequest struct {
	Number int         `json:"number"`
	Head   PullRef     `json:"head"`
	Base   PullBaseRef `json:"base"`
}

type Ref struct {
	SHA string
}

type Repository struct {
	Owner string
	Name  string
}

type StatusError struct {
	Status  int
	Message string
}

type Tree struct {
	SHA       string
	Entries   []TreeEntry
	Truncated bool
}

type TreeEntry struct {
	Path string `json:"path"`
	Mode string `json:"mode"`
	Type string `json:"type"`
	SHA  string `json:"sha"`
}

type TreeReader interface {
	GetTree(ctx context.Context, owner, repo, sha string, recursive bool) (Tree, error)
}

type TreeWriter interface {
	CreateTree(ctx context.Context, owner, repo string, entries []TreeEntry, baseTree string) (string, error)
	CreateCommit(ctx context.Context, owner, repo string, message, tree string, parents []string) (string, error)
}