webhook

type AttemptStore interface {
	SaveDeployAttempt(ctx context.Context, a store.DeployAttempt) error
	FinishDeployAttempt(ctx context.Context, id, status string, finishedAt time.Time, errMsg string) error
}

type Config struct {
	// Secret is the shared HMAC secret configured on the GitHub webhook,
	// used to verify the X-Hub-Signature-256 header. Required: a Handler
	// built with an empty Secret rejects every request, since an empty
	// secret would make the signature check meaningless.
	Secret []byte
	// RepoURL is the git remote this handler clones on a triggering
	// push, e.g. "https://github.com/org/thesvg.org.git". Deliberately
	// server-side configuration, never taken from the webhook payload:
	// only the commit SHA (a hash, not a URL) comes from the untrusted
	// request, so a forged payload cannot redirect a clone at an
	// attacker-controlled remote.
	RepoURL string
	// Branch triggers a deploy on push. Pushes to any other branch are
	// accepted (200 OK, so GitHub does not retry) but do not deploy.
	// Defaults to DefaultBranch when empty.
	Branch string
	// ServiceName, Service, and ImageRepo are passed straight through to
	// deploy.Request; see internal/deploy for what each means. Ignored
	// when Services (below) is non-empty.
	ServiceName string
	Service     spec.Service
	ImageRepo   string

	// Services, when non-empty, switches a triggering push from a
	// single-service Deploy call to a multi-service DeploySpec fan-out
	// (deploy.MultiRequest): ServiceName above becomes the app name every
	// fanned-out service links to, and ImageRepo above becomes the image
	// repo base every fanned-out service tags under. This is still
	// single-app, env-var-configured Config, exactly like every other
	// field here (the package doc comment's own scope boundary): Services
	// is one more static, operator-configured value, not a per-push
	// choice, so it does not reopen the "no multi-tenant registry" design
	// decision that comment already makes.
	Services map[string]spec.Service
}

type DeployNotifier interface {
	Dispatch(ctx context.Context, resourceID string, ev alerting.DeployOutcome)
}

type Deployer interface {
	Deploy(ctx context.Context, req deploy.Request, progress func(build.ProgressEvent)) (string, error)
	// DeploySpec is the multi-service fan-out entry point, exercised only
	// when Config.Services is non-empty (see Config's own doc comment).
	// Same *deploy.Pipeline satisfies both methods.
	DeploySpec(ctx context.Context, req deploy.MultiRequest, progress func(serviceKey string, ev build.ProgressEvent)) ([]deploy.ServiceOutcome, error)
}

type Handler struct {
	// contains filtered or unexported fields
}

type IssueCommentEvent struct {
	Action        string
	CommentID     int64
	Body          string
	Commenter     string
	CommenterType string
	// PerformedViaApp is true when a GitHub App wrote the comment.
	PerformedViaApp bool
	SenderType      string
	Number          int
	// IsPullRequest is false for a comment on a plain issue.
	IsPullRequest bool
	RepoFullName  string
}

type MergeGroupEvent struct {
	// Action is "checks_requested" when the queue wants checks to run, or
	// "destroyed" when the group is dissolved.
	Action  string
	HeadSHA string
	// HeadRef is the temporary queue branch, a full "refs/heads/..." ref.
	HeadRef string
	// BaseRef is the branch the group merges into, a full "refs/heads/..." ref.
	BaseRef string
	BaseSHA string
}

type PullRequestAction string

type PullRequestEvent struct {
	Action PullRequestAction
	Number int
	// HeadRef is the pull request's source branch name, not a full
	// "refs/heads/"-prefixed ref: unlike PushEvent.Ref, no provider's
	// pull request payload carries one, and a preview deploy only ever
	// needs the branch name to name/label the preview, not to match it
	// against a target ref.
	HeadRef string
	HeadSHA string
	// BaseRef is the pull request's target branch name, compared against
	// a connected git source's own Branch the same way PushEvent.Ref is
	// compared against Config.TargetRef: a pull request against any
	// other branch is ignored.
	BaseRef string
	// HeadRepoFullName and BaseRepoFullName are the "owner/name" of the
	// repositories the source and target branches live in. Empty when the
	// payload carries none (for example a deleted fork).
	HeadRepoFullName string
	BaseRepoFullName string
	// Reopened marks an Opened action that was a reopened pull request
	// rather than a new one.
	Reopened bool
}

type PushEvent struct {
	Ref   string `json:"ref"`
	After string `json:"after"`
	// Before is the commit the branch moved from, the stale-deploy guard's
	// strongest ordering signal.
	Before string `json:"before"`
	// Deleted marks a push that removed the ref (all-zero After on GitHub,
	// GitLab and Gitea, a null new ref on Bitbucket).
	Deleted bool `json:"deleted"`
	// HeadCommitAt is the pushed head commit's timestamp, zero if unknown.
	HeadCommitAt time.Time `json:"-"`
	// HeadMessage and HeadAuthor are the pushed head commit's message and
	// author name, empty when the payload carries none.
	HeadMessage string `json:"-"`
	HeadAuthor  string `json:"-"`
	// RepoNames and RepoURLs identify the repository the push is for
	// (full_name, path_with_namespace, clone/ssh/html URLs). Empty when
	// the payload does not say, which callers must treat as "unknown".
	RepoNames []string `json:"-"`
	RepoURLs  []string `json:"-"`
	// Changed lists the files the pushed commits touched. Nil means the
	// payload did not say (no commit list, or a list the provider truncates).
	Changed []string `json:"-"`
}

type ReconcileNudger interface {
	Nudge()
}