commitstatus

type Backend string

type Outcome string

type Provider string

type Request struct {
	Provider     Provider
	APIBaseURL   string
	RepoURL      string
	RepoFullName string
	CommitSHA    string
	Token        string
	Context      string
	Target       *Target
}

type RequestParams struct {
	// Enabled mirrors the application-level "post commit statuses" toggle
	// (e.g. app.Config.GitCommitStatus). When false, ResolveRequest always skips.
	Enabled bool
	// SourceIsGit must be true for commit statuses to be posted/read; OCI (or
	// any other non-Git) sources are always skipped.
	SourceIsGit bool
	// SourceURL is the repository URL used both for credential resolution and,
	// when PayloadWebURL/PayloadFullName are empty, as the repository identity.
	SourceURL string
	// CommitSHA is the resolved commit the status applies to. Empty skips.
	CommitSHA string
	// PayloadWebURL optionally overrides SourceURL as the repository URL (e.g.
	// the browsable web URL from a webhook payload).
	PayloadWebURL string
	// PayloadFullName optionally overrides the "owner/repo" full name derived
	// from the repository URL (e.g. from a webhook payload).
	PayloadFullName string
	// ProviderOverride is the raw configured SCM provider (e.g. app.Config.GitScmProvider).
	// Empty/"auto" auto-detects the provider from the repository URL.
	ProviderOverride string
	// APIBaseURL optionally overrides the inferred SCM API base URL (e.g. app.Config.GitScmApiUrl).
	APIBaseURL string
	// AccessToken is the configured fallback access token (e.g. app.Config.GitAccessToken),
	// used when no scoped/GitHub App credential is resolved for SourceURL.
	AccessToken string
	// ContextName is the commit status context label (e.g. "doco-cd/demo").
	// Empty defaults to DeployContext.
	ContextName string
	// Target pins an already-started reporting attempt, including handovers.
	Target *Target
	// Scope separates deployments with the same check name on different Docker contexts.
	Scope string
}

type State string

type Status struct {
	State       State
	Outcome     Outcome
	Description string
	// Summary optionally explains the status in Markdown. Only GitHub check
	// runs show it, other providers only show the description.
	Summary string
	// Context is the label shown in the Git UI (e.g. "doco-cd/demo").
	// Defaults to BaseContext when empty.
	Context   string
	TargetURL string // optional link to deployment logs
	// Phase is the current phase of a running deployment, e.g. "pulling
	// images". GitHub check runs show it in their title.
	Phase string
}

type Target struct {
	Backend    Backend   `json:"backend"`
	ExternalID string    `json:"external_id,omitempty"`
	CheckRunID int64     `json:"check_run_id,omitempty"`
	AppID      string    `json:"app_id,omitempty"`
	Scope      string    `json:"scope,omitempty"`
	StartedAt  time.Time `json:"started_at,omitzero"`
}