model

package
v6.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// BuildCacheGlobalStorage selects entries kept in the server's storage.
	BuildCacheGlobalStorage int64 = 0
	// BuildCacheAnyStorage selects entries regardless of where they are kept.
	BuildCacheAnyStorage int64 = -1
	// BuildCacheOwnBuckets selects entries kept in any bucket an org connected.
	BuildCacheOwnBuckets int64 = -2
)

Bucket selectors of BuildCacheFilter.BucketID besides a bucket's ID.

View Source
const (
	// BuildCacheLimitDefault applies the server-wide default.
	BuildCacheLimitDefault int64 = 0
	// BuildCacheLimitNone lifts the limit; for a TTL it keeps entries until
	// they are evicted by size.
	BuildCacheLimitNone int64 = -1
)

Limit values of BuildCacheSettings. Positive values are explicit limits.

View Source
const (
	MetricDimensionOrg   = "org"
	MetricDimensionRepo  = "repo"
	MetricDimensionAgent = "agent"
	MetricDimensionTime  = "time"

	MetricPipelineCount  = "pipeline_count"
	MetricWorkflowCount  = "workflow_count"
	MetricAvgBuildTime   = "avg_build_time"
	MetricTotalBuildTime = "total_build_time"
	MetricAvgSteps       = "avg_steps"

	MetricBucketDay   = "day"
	MetricBucketWeek  = "week"
	MetricBucketMonth = "month"

	MetricUnitCount   = "count"
	MetricUnitSeconds = "seconds"
)

Chart-builder dimensions, metrics, time buckets and units. The API validates requests against these and the store branches on them.

View Source
const (
	ProcLogSourceTypeAgent      = "agent"
	ProcLogSourceTypeAutoscaler = "autoscaler"
)
View Source
const (
	FailureIgnore = "ignore"
	FailureFail   = "fail"
)

Different ways to handle failure states.

View Source
const (
	// DefaultProvisionTimeoutSeconds is the time after which pending agents are
	// considered stale (5 minutes), unless the autoscaler reports its own.
	DefaultProvisionTimeoutSeconds = 300
)
View Source
const DefaultVaultTimeoutSeconds = 30

DefaultVaultTimeoutSeconds is the default HTTP request timeout in seconds.

View Source
const (
	IDNotSet = -1
)
View Source
const MaxProvisioningPhases = 20

MaxProvisioningPhases caps how many provisioning phases an agent keeps; the oldest are dropped first.

View Source
const SystemAdminLogin = "crow-admin"

SystemAdminLogin is the login of the dedicated, forge-less admin user that owns the bootstrap access token seeded from CROW_ADMIN_TOKEN.

Variables

View Source
var (
	ErrAccessTokenNameInvalid   = errors.New("invalid access token name")
	ErrAccessTokenNameTooLong   = errors.New("access token name too long")
	ErrAccessTokenScopesInvalid = errors.New("invalid access token scopes")
	ErrAccessTokenScopesEmpty   = errors.New("at least one scope is required")
	ErrAccessTokenExpired       = errors.New("access token expired")
	ErrAccessTokenAdminScope    = errors.New("admin scopes require an instance role that grants them")
)
View Source
var (
	ErrIntegrationNameInvalid   = errors.New("invalid integration name")
	ErrIntegrationTypeInvalid   = errors.New("invalid integration type")
	ErrIntegrationConfigInvalid = errors.New("invalid integration configuration")
	ErrIntegrationAccessDenied  = errors.New("access denied to integration")
	ErrIntegrationNotFound      = errors.New("integration not found")
	ErrIntegrationInactive      = errors.New("integration is not active")
	ErrIntegrationEventDenied   = errors.New("integration is not allowed for this pipeline event")
)

Integration errors.

View Source
var (
	ErrSecretNameInvalid  = errors.New("invalid secret name")
	ErrSecretImageInvalid = errors.New("invalid secret image")
	ErrSecretValueInvalid = errors.New("invalid secret value")
	ErrSecretEventInvalid = errors.New("invalid secret event")
)
View Source
var (
	ErrSecretTargetExists   = errors.New("secret target already exists")
	ErrSecretTargetNotFound = errors.New("secret target not found")
	ErrSecretNameConflict   = errors.New("a secret with this name already targets this entity")
)

DefaultIntegrationEvents are the pipeline events an integration serves secrets to when it has no explicit event filter. Pull request events are left out on purpose: pull request pipelines run code from the pull request author (possibly from a fork), so serving them secrets has to be an explicit decision.

View Source
var ErrInvalidApprovalState = errors.New("invalid approval state")
View Source
var ErrInvalidStatusValue = errors.New("invalid status value")
View Source
var ErrInvalidWebhookEvent = errors.New("invalid webhook event")
View Source
var ErrNotificationConfigNotFound = errors.New("notification config not found")
View Source
var ErrRoleInvalid = errors.New("invalid role")

ErrRoleInvalid is returned for a role name Crow does not know.

ValidIntegrationTypes lists all supported integration types.

Functions

func ApplyPagination

func ApplyPagination[T any](d *ListOptions, slice []T) []T

func GenerateNewAgentToken

func GenerateNewAgentToken() string

func GenerateNewAutoscalerToken

func GenerateNewAutoscalerToken() string

GenerateNewAutoscalerToken generates a new random token for autoscaler authentication.

func GeneratePersistentID

func GeneratePersistentID(token, name, platform, backend string) string

GeneratePersistentID creates a stable identity hash for an agent. For individual token agents, the token alone provides uniqueness. For master token agents, the name (hostname) differentiates agents sharing the same token. This hash persists across agent restarts and ID changes, allowing metrics aggregation.

func IsReservedAgentLabel added in v6.11.0

func IsReservedAgentLabel(key string) bool

IsGlobal reports whether the agent can process tasks from any organization. IsReservedAgentLabel reports whether a label key uses the crowci/ prefix that the server reserves for its own task metadata and agent scoping. Agents must not advertise such labels as custom labels: a custom crowci/org-id would let an org-scoped agent claim another org's tasks.

func IsThereRunningStage

func IsThereRunningStage(workflows []*Workflow) bool

IsThereRunningStage determine if it contains workflows running or pending to run. Only considers the latest attempt of each workflow.

func MetricUnit added in v6.2.0

func MetricUnit(metric string) string

Unit returns the value unit produced by the given metric.

func ParseRepo

func ParseRepo(str string) (user, repo string, err error)

ParseRepo parses the repository owner and name from a string.

func StripReservedAgentLabels added in v6.11.0

func StripReservedAgentLabels(labels map[string]string) (map[string]string, []string)

StripReservedAgentLabels returns a copy of labels without reserved keys, and the sorted keys that were removed.

Types

type AccessToken

type AccessToken struct {
	bun.BaseModel `bun:"table:access_tokens"`

	ID        int64           `json:"id"         bun:"id,pk,autoincrement"`
	UserID    int64           `json:"user_id"    bun:"user_id,notnull"`
	OrgID     int64           `json:"org_id"     bun:"org_id,notnull,default:0"`
	RepoID    int64           `json:"repo_id"    bun:"repo_id,notnull,default:0"`
	Name      string          `json:"name"       bun:"name,notnull"`
	TokenHash string          `json:"-"          bun:"token_hash,unique,type:varchar(64)"`
	Scopes    JSONSliceString `json:"scopes"     bun:"scopes,type:text"`
	ExpiresAt int64           `json:"expires_at" bun:"expires_at"`
	LastUsed  int64           `json:"last_used"  bun:"last_used"`
	CreatedAt int64           `json:"created_at" bun:"created_at,nullzero"`
	UpdatedAt int64           `json:"updated_at" bun:"updated_at,nullzero"`

} //	@name	AccessToken

AccessToken represents a user-created API access token.

func (*AccessToken) Allows added in v6.11.0

func (at *AccessToken) Allows(required AccessTokenScope) bool

Allows reports whether any scope of the token satisfies required.

func (*AccessToken) AllowsRepo added in v6.11.0

func (at *AccessToken) AllowsRepo(repo *Repo) bool

AllowsRepo reports whether the token's org/repo restriction admits repo.

func (*AccessToken) BeforeAppendModel added in v6.11.0

func (t *AccessToken) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*AccessToken) Copy

func (at *AccessToken) Copy() *AccessToken

Copy returns a copy of the access token without sensitive data.

func (*AccessToken) GetScopes

func (at *AccessToken) GetScopes() []AccessTokenScope

GetScopes returns the scopes as AccessTokenScope slice.

func (*AccessToken) HasScope

func (at *AccessToken) HasScope(required AccessTokenScope) bool

HasScope returns true if the token has the specified scope.

func (*AccessToken) IsExpired

func (at *AccessToken) IsExpired() bool

IsExpired returns true if the token has expired.

func (*AccessToken) IsOrgScoped

func (at *AccessToken) IsOrgScoped() bool

IsOrgScoped returns true if the token is scoped to a specific organization.

func (*AccessToken) IsRepoScoped

func (at *AccessToken) IsRepoScoped() bool

IsRepoScoped returns true if the token is scoped to a specific repository.

func (*AccessToken) IsUserLevel

func (at *AccessToken) IsUserLevel() bool

IsUserLevel returns true if the token is not scoped to an org or repo.

func (AccessToken) TableName

func (AccessToken) TableName() string

TableName returns the database table name.

func (*AccessToken) Validate

func (at *AccessToken) Validate(user *User) error

Validate validates the access token fields for a token owned by user.

type AccessTokenScope

type AccessTokenScope string

AccessTokenScope represents permission scopes for access tokens.

const (
	// User scopes - available to all users.
	ScopeRepoRead  AccessTokenScope = "repo:read"
	ScopeRepoWrite AccessTokenScope = "repo:write"
	ScopeRepoAdmin AccessTokenScope = "repo:admin"
	ScopeUserRead  AccessTokenScope = "user:read"
	ScopeUserWrite AccessTokenScope = "user:write"

	// Admin-only scopes.
	ScopeAdminRead  AccessTokenScope = "admin:read"
	ScopeAdminWrite AccessTokenScope = "admin:write"
)

func AllAdminScopes

func AllAdminScopes() []AccessTokenScope

AllAdminScopes returns all scopes available only to admins.

func AllScopes

func AllScopes() []AccessTokenScope

AllScopes returns all available scopes.

func AllUserScopes

func AllUserScopes() []AccessTokenScope

AllUserScopes returns all scopes available to regular users.

func (AccessTokenScope) IsAdminScope

func (s AccessTokenScope) IsAdminScope() bool

IsAdminScope returns true if the scope requires admin privileges.

func (AccessTokenScope) IsValid

func (s AccessTokenScope) IsValid() bool

IsValid returns true if the scope is a valid defined scope.

func (AccessTokenScope) Satisfies added in v6.11.0

func (s AccessTokenScope) Satisfies(required AccessTokenScope) bool

Satisfies reports whether holding scope s grants required. Within a family a higher scope implies the lower ones: repo:admin includes repo:write and repo:read, user:write includes user:read and admin:write includes admin:read.

type AccessTokenStore

type AccessTokenStore interface {
	AccessTokenCreate(*AccessToken) error
	AccessTokenFind(int64) (*AccessToken, error)
	AccessTokenFindByHash(string) (*AccessToken, error)
	AccessTokenList(userID int64, p *ListOptions) ([]*AccessToken, error)
	AccessTokenDelete(*AccessToken) error
	AccessTokenUpdateLastUsed(int64, int64) error
}

AccessTokenStore defines the interface for access token persistence.

type AdminMetrics

type AdminMetrics = Metrics

AdminMetrics is deprecated, use Metrics instead. Keeping for backward compatibility during migration.

type Agent

type Agent struct {
	bun.BaseModel `bun:"table:agents"`

	ID                     int64               `json:"id"            bun:"id,pk,autoincrement"`
	Created                int64               `json:"created"       bun:",nullzero"`
	Updated                int64               `json:"updated"       bun:",nullzero"`
	Name                   string              `json:"name"          bun:"name"`
	OwnerID                int64               `json:"owner_id"      bun:"owner_id"`
	Token                  string              `json:"-"                         bun:"token"`
	PersistentID           string              `json:"persistent_id"             bun:"persistent_id,type:varchar(64)"`
	LastContact            int64               `json:"last_contact"              bun:"last_contact"`
	WorkflowPollingHealthy bool                `json:"workflow_polling_healthy"  bun:"workflow_polling_healthy"`
	LastWork               int64               `json:"last_work"                 bun:"last_work"`
	Platform               string              `json:"platform"                  bun:"platform,type:varchar(100)"`
	Backend                string              `json:"backend"       bun:"backend,type:varchar(100)"`
	Hostname               string              `json:"hostname"      bun:"hostname,type:varchar(255)"`
	Capacity               int32               `json:"capacity"      bun:"capacity"`
	Version                string              `json:"version"       bun:"version"`
	BuildDate              string              `json:"build_date"    bun:"build_date"`
	NoSchedule             bool                `json:"no_schedule"   bun:"no_schedule"`
	Priority               int32               `json:"priority"      bun:"priority,default:0"`
	CustomLabels           JSONMapStringString `json:"custom_labels"    bun:"custom_labels,type:text"`
	LimitMem               int64               `json:"limit_mem"        bun:"limit_mem"`
	LimitCPUQuota          int64               `json:"limit_cpu_quota"  bun:"limit_cpu_quota"`
	// HostCPUs and HostMem are reported by the agent and describe the machine
	// running the workloads, not the machine running the agent process. They are
	// zero for backends that cannot determine them (e.g. Kubernetes).
	HostCPUs int32 `json:"host_cpus" bun:"host_cpus"`
	HostMem  int64 `json:"host_mem"  bun:"host_mem"`
	// ProtocolVersion is the agent protocol version reported on registration.
	// Zero means the agent has not registered since the server started recording it.
	ProtocolVersion int32 `json:"protocol_version" bun:"protocol_version"`
	// RemoteUpdate is how the agent reacts to a restart request, "restart" or
	// empty when it ignores them. Reported by the agent on registration.
	RemoteUpdate string `json:"remote_update" bun:"remote_update,type:varchar(20)"`
	// RestartRequested makes the server stop handing the agent work and ask it
	// to exit once idle. Cleared when the agent registers again. Written only
	// through AgentSetRestartRequested, so a concurrent AgentUpdate from a
	// health report cannot undo a request.
	RestartRequested bool `json:"restart_requested" bun:"restart_requested"`
	// RestartQueued marks the agent for a restart that waits for a free slot
	// under the parallel restart limit. Written only through the restart store
	// methods, like RestartRequested.
	RestartQueued bool `json:"restart_queued" bun:"restart_queued"`
	// AutoRestartVersion is the server release under which the automatic
	// restart policy last asked the agent to restart. The policy asks at most
	// once per server release, so an agent that comes back on the same old
	// release is not restarted in a loop.
	AutoRestartVersion string `json:"-" bun:"auto_restart_version,type:varchar(255)"`
	// OrgIDs scopes the agent to one or more organizations. An empty list means
	// the agent is global and can process tasks from any organization.
	OrgIDs JSONSliceInt64 `json:"org_ids" bun:"org_ids,type:text"`
	// Provisioning is the progress the agent's host reported while it was being
	// set up, oldest first, capped at MaxProvisioningPhases entries.
	Provisioning JSONSliceProvisioningPhase `json:"provisioning,omitempty" bun:"provisioning,type:text"`

} //	@name	Agent

func (*Agent) AddProvisioningPhase added in v6.12.0

func (a *Agent) AddProvisioningPhase(phase ProvisioningPhase)

AddProvisioningPhase appends a phase, dropping the oldest beyond MaxProvisioningPhases.

func (*Agent) BeforeAppendModel added in v6.11.0

func (a *Agent) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*Agent) CanAccessRepo

func (a *Agent) CanAccessRepo(repo *Repo) bool

func (*Agent) GetServerLabels

func (a *Agent) GetServerLabels() (map[string]string, error)

func (*Agent) IsGlobal

func (a *Agent) IsGlobal() bool

func (*Agent) IsSystemAgent

func (a *Agent) IsSystemAgent() bool

func (Agent) TableName

func (Agent) TableName() string

TableName returns the database table name.

type AgentListOptions

type AgentListOptions struct {
	ListOptions
	Search   string // Search in name, platform, backend, custom labels
	Platform string // Filter by platform
	Backend  string // Filter by backend
	Sort     string // Sort field: id, name, platform, backend, last_contact
	Order    string // Sort order: asc or desc
}

AgentListOptions defines filtering options for listing agents.

type AgentMetric

type AgentMetric struct {
	AgentID           int64   `json:"agent_id"`
	AgentPersistentID string  `json:"agent_persistent_id,omitempty"`
	AgentName         string  `json:"agent_name"`
	WorkflowCount     int64   `json:"workflow_count"`
	AvgBuildTime      float64 `json:"avg_build_time"` // in seconds
	Platform          string  `json:"platform"`
	Backend           string  `json:"backend"`
}

AgentMetric represents metrics for a specific agent.

type AgentMetricData

type AgentMetricData struct {
	AgentPersistentID string
	AgentName         string
	Platform          string
	Count             int64
}

AgentMetricData holds aggregated workflow data for an agent persistent ID. Used by store methods to return agent metrics grouped by persistent ID.

type AgentWithStats

type AgentWithStats struct {
	Agent
	RunningWorkflows int `json:"running_workflows"`
}

AgentWithStats is used for API responses to include runtime stats.

type AgentWithToken added in v6.11.0

type AgentWithToken struct {
	Agent
	Token string `json:"token"`

} //	@name	AgentWithToken

AgentWithToken is used for API responses that include the token (only on creation). Agent.Token is never serialized to JSON, so every other response omits it.

type AgentWorkflow

type AgentWorkflow struct {
	Workflow
	RepoID         int64 `json:"repo_id"         bun:"repo_id,scanonly"`
	PipelineNumber int64 `json:"pipeline_number" bun:"pipeline_number,scanonly"`
}

AgentWorkflow is a historic workflow processed by an agent, enriched with the owning pipeline's repo and number so the frontend can deep-link to it.

type ApprovalAction

type ApprovalAction string //	@name	ApprovalAction

ApprovalAction is the verb recorded in a WorkflowApprovalEvent.

const (
	ApprovalActionApproved ApprovalAction = "approved"
	ApprovalActionDeclined ApprovalAction = "declined"
	ApprovalActionExpired  ApprovalAction = "expired"
)

type ApprovalMode

type ApprovalMode string
const (
	RequireApprovalNone         ApprovalMode = "none"          // require approval for no events
	RequireApprovalForks        ApprovalMode = "forks"         // require approval for PRs from forks (default)
	RequireApprovalPullRequests ApprovalMode = "pull_requests" // require approval for all PRs
	RequireApprovalAllEvents    ApprovalMode = "all_events"    // require approval for all external events
)

func (ApprovalMode) Valid

func (mode ApprovalMode) Valid() bool

type ApprovalState

type ApprovalState string //	@name	ApprovalState

ApprovalState describes the lifecycle of a workflow-level approval gate.

const (
	ApprovalNone     ApprovalState = ""         // gate not configured on this workflow
	ApprovalPending  ApprovalState = "pending"  // waiting for a human decision
	ApprovalApproved ApprovalState = "approved" // approved; workflow may proceed
	ApprovalDeclined ApprovalState = "declined" // explicitly declined by an approver
	ApprovalExpired  ApprovalState = "expired"  // auto-declined by the timeout sweeper
)

func (ApprovalState) Granted added in v6.8.0

func (s ApprovalState) Granted() bool

Granted reports whether the gate lets the workflow proceed.

func (ApprovalState) Terminal

func (s ApprovalState) Terminal() bool

Terminal reports whether the state is final (no further transitions).

func (ApprovalState) Validate

func (s ApprovalState) Validate() error

type ApprovedPullRequest

type ApprovedPullRequest struct {
	bun.BaseModel `bun:"table:approved_pull_requests"`

	ID         int64  `json:"id"          bun:"id,pk,autoincrement"`
	RepoID     int64  `json:"repo_id"     bun:"repo_id,unique:s"`
	Ref        string `json:"ref"         bun:"ref,unique:s"`
	ApprovedBy string `json:"approved_by" bun:"approved_by"`
	Created    int64  `json:"created"     bun:"created,notnull,default:0"`
}

func (*ApprovedPullRequest) BeforeAppendModel added in v6.11.0

func (a *ApprovedPullRequest) BeforeAppendModel(_ context.Context, query bun.Query) error

func (ApprovedPullRequest) TableName

func (ApprovedPullRequest) TableName() string

type Autoscaler

type Autoscaler struct {
	bun.BaseModel `bun:"table:autoscalers"`

	ID                int64               `json:"id"                    bun:"id,pk,autoincrement"`
	Created           int64               `json:"created"               bun:",nullzero"`
	Updated           int64               `json:"updated"               bun:",nullzero"`
	Name              string              `json:"name"                  bun:"name,unique,notnull"`
	Token             string              `json:"-"                     bun:"token"`
	OwnerID           int64               `json:"owner_id"              bun:"owner_id"`
	LastContact       int64               `json:"last_contact"          bun:"last_contact"`
	MinAgents         int32               `json:"min_agents"            bun:"min_agents"`
	MaxAgents         int32               `json:"max_agents"            bun:"max_agents"`
	WorkflowsPerAgent int32               `json:"workflows_per_agent"   bun:"workflows_per_agent"`
	Provider          string              `json:"provider"              bun:"provider,type:varchar(50)"`
	InstanceType      string              `json:"instance_type"         bun:"instance_type,type:varchar(100)"`
	Region            string              `json:"region"                bun:"region,type:varchar(100)"`
	AgentLabels       JSONMapStringString `json:"agent_labels"          bun:"agent_labels,type:text"`
	LimitCPUQuota     string              `json:"limit_cpu_quota"       bun:"limit_cpu_quota,type:varchar(50)"`
	LimitMem          string              `json:"limit_mem"             bun:"limit_mem,type:varchar(50)"`
	Enabled           bool                `json:"enabled"               bun:"enabled,default:true"`
	Version           string              `json:"version"               bun:"version"`
	ActiveAgents      int32               `json:"active_agents"         bun:"active_agents"`
	PendingAgents     int32               `json:"pending_agents"        bun:"pending_agents"`
	PendingSince      int64               `json:"pending_since"         bun:"pending_since"`
	OrgID             int64               `json:"org_id"                bun:"org_id"`
	// PendingAgentIDs are the agents the autoscaler has started that have not
	// connected yet, as reported in its last heartbeat.
	PendingAgentIDs JSONSliceInt64 `json:"pending_agent_ids" bun:"pending_agent_ids,type:text"`
	// ProvisionTimeout is how long, in seconds, the autoscaler expects an agent
	// to take to connect. Zero means DefaultProvisionTimeoutSeconds.
	ProvisionTimeout int64 `json:"provision_timeout" bun:"provision_timeout"`

} //	@name	Autoscaler

Autoscaler represents an autoscaler instance that provisions agents on demand.

func (*Autoscaler) BeforeAppendModel added in v6.11.0

func (a *Autoscaler) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*Autoscaler) CanProvision

func (a *Autoscaler) CanProvision(requiredLabels map[string]string) bool

CanProvision checks if the autoscaler can provision an agent with the given labels. The matching mirrors the queue's agent filter (see server/grpc/filter.go) so that a pending task is only flagged as "being provisioned" when an agent the autoscaler spins up would actually be eligible to run it.

func (*Autoscaler) IsHealthy

func (a *Autoscaler) IsHealthy() bool

IsHealthy returns true if the autoscaler has sent a heartbeat recently (within 120 seconds).

func (*Autoscaler) IsProvisioningStale

func (a *Autoscaler) IsProvisioningStale() bool

IsProvisioningStale returns true if agents have been pending longer than the timeout.

func (*Autoscaler) IsSystemAutoscaler

func (a *Autoscaler) IsSystemAutoscaler() bool

IsSystemAutoscaler returns true if the autoscaler is a system-level (global) autoscaler.

func (*Autoscaler) ProvisionTimeoutSeconds added in v6.12.0

func (a *Autoscaler) ProvisionTimeoutSeconds() int64

ProvisionTimeoutSeconds returns how long the autoscaler expects an agent to take to connect.

func (Autoscaler) TableName

func (Autoscaler) TableName() string

TableName returns the database table name.

type AutoscalerListOptions

type AutoscalerListOptions struct {
	ListOptions
	Search   string // Search in name, provider
	Provider string // Filter by provider
	Enabled  *bool  // Filter by enabled status (nil = all)
	OrgID    *int64 // Filter by org_id (nil = all, -1 = global autoscalers only)
	Sort     string // Sort field: id, name, provider, last_contact
	Order    string // Sort order: asc or desc
}

AutoscalerListOptions defines filtering options for listing autoscalers.

type AutoscalerWithToken

type AutoscalerWithToken struct {
	Autoscaler
	Token string `json:"token"`

} //	@name	AutoscalerWithToken

AutoscalerWithToken is used for API responses that include the token (only on creation).

type AzureKeyVaultConfig

type AzureKeyVaultConfig struct {
	VaultURL     string `json:"vault_url"`     // Key Vault URL (e.g., https://my-vault.vault.azure.net)
	TenantID     string `json:"tenant_id"`     // Azure AD Tenant ID
	ClientID     string `json:"client_id"`     // Service Principal Client ID
	ClientSecret string `json:"client_secret"` // Service Principal Client Secret
}

AzureKeyVaultConfig holds Azure Key Vault specific configuration.

func (*AzureKeyVaultConfig) Redacted

Redacted returns a copy with sensitive fields redacted.

func (*AzureKeyVaultConfig) Validate

func (c *AzureKeyVaultConfig) Validate() error

Validate validates the Azure Key Vault configuration.

func (*AzureKeyVaultConfig) WithDefaults

func (c *AzureKeyVaultConfig) WithDefaults() *AzureKeyVaultConfig

WithDefaults returns a copy with default values applied.

type BuildCache added in v6.11.0

type BuildCache struct {
	bun.BaseModel `bun:"table:build_caches"`

	ID     int64 `json:"id"         bun:"id,pk,autoincrement"`
	RepoID int64 `json:"repo_id"    bun:"repo_id,notnull,unique:build_cache_key"`

	// Scope is the git ref the entry was saved from, e.g. "refs/heads/main".
	// A workflow reads its own scope and the default branch, and writes only
	// its own, so one branch cannot plant a cache another branch restores.
	Scope string `json:"scope"      bun:"scope,type:varchar(255),notnull,unique:build_cache_key"`

	// Key is the user-defined cache key after template rendering.
	Key string `json:"key"        bun:"cache_key,type:varchar(255),notnull,unique:build_cache_key"`

	// Size is the archive size in bytes: the reserved size while the upload is
	// pending, the stored size once committed.
	Size int64 `json:"size"       bun:"size,notnull,default:0"`

	// BucketID is the bucket the archive is stored in: 0 for the server's
	// storage, otherwise the BuildCacheBucket its org connected.
	BucketID int64 `json:"bucket_id"  bun:"bucket_id,notnull,default:0"`

	// Committed is false while the archive is being uploaded. Pending entries
	// are never restored and are removed when their upload is abandoned.
	Committed bool  `json:"committed"  bun:"committed,notnull,default:false"`
	Created   int64 `json:"created"    bun:"created,notnull,default:0"`
	LastUsed  int64 `json:"last_used"  bun:"last_used,notnull,default:0"`

} //	@name	BuildCache

BuildCache is one archive of workspace paths saved by a workflow's cache step under a key. Entries are immutable: a key is written once per scope and replaced only after it was evicted.

func (BuildCache) TableName added in v6.11.0

func (BuildCache) TableName() string

TableName returns the database table name.

type BuildCacheBucket added in v6.12.0

type BuildCacheBucket struct {
	bun.BaseModel `bun:"table:build_cache_buckets"`

	ID        int64  `json:"id"         bun:"id,pk,autoincrement"`
	OrgID     int64  `json:"org_id"     bun:"org_id,notnull,unique"`
	Endpoint  string `json:"endpoint"   bun:"endpoint,type:varchar(255),notnull"`
	Bucket    string `json:"bucket"     bun:"bucket,type:varchar(255),notnull"`
	Region    string `json:"region"     bun:"region,type:varchar(255)"`
	Prefix    string `json:"prefix"     bun:"prefix,type:varchar(255)"`
	AccessKey string `json:"access_key" bun:"access_key,type:varchar(255)"`
	// SecretKey is never sent to clients.
	SecretKey string `json:"-"          bun:"secret_key,type:text"`
	// SSL has no bun default: bun would write the default in place of false.
	SSL       bool `json:"ssl"        bun:"use_ssl,notnull"`
	PathStyle bool `json:"path_style" bun:"path_style,notnull"`
	// MaxSize caps the size of the caches in the bucket and MaxEgress the
	// bytes restored from it per calendar month (UTC); 0 is unlimited. The
	// org sets them, the server's limits do not apply to its bucket.
	MaxSize   int64 `json:"max_size"   bun:"max_size,notnull"`
	MaxEgress int64 `json:"max_egress" bun:"max_egress,notnull"`
	// TTL removes entries not restored for this many seconds; 0 applies the
	// server default, -1 keeps them until removed by hand.
	TTL     int64 `json:"ttl"        bun:"ttl,notnull,default:0"`
	Created int64 `json:"created"    bun:"created,notnull,default:0"`
	Updated int64 `json:"updated"    bun:"updated,notnull,default:0"`

} //	@name	BuildCacheBucket

BuildCacheBucket is an S3-compatible bucket an org connected to keep its caches in instead of the server's storage. The cache step up- and downloads through presigned URLs, so the bucket must be reachable from pipeline steps.

func (BuildCacheBucket) TableName added in v6.12.0

func (BuildCacheBucket) TableName() string

TableName returns the database table name.

type BuildCacheFilter added in v6.12.0

type BuildCacheFilter struct {
	RepoID int64
	// OrgID selects the entries of the repos currently owned by this org.
	OrgID int64
	// BucketID is a bucket ID or one of the BuildCache*Storage selectors.
	BucketID int64
	// NotOrgIDs and NotBucketIDs exclude entries of these orgs and buckets.
	NotOrgIDs    []int64
	NotBucketIDs []int64
}

BuildCacheFilter narrows the cache entries a store query covers. Zero values do not filter, except BucketID, whose zero selects the server's storage.

type BuildCacheSettings added in v6.12.0

type BuildCacheSettings struct {
	bun.BaseModel `bun:"table:build_cache_settings"`

	OrgID int64 `json:"org_id"     bun:"org_id,pk"`
	// MaxSize caps the size of the org's caches in bytes.
	MaxSize int64 `json:"max_size"   bun:"max_size,notnull,default:0"`
	// MaxEgress caps the bytes restored per calendar month (UTC).
	MaxEgress int64 `json:"max_egress" bun:"max_egress,notnull,default:0"`
	// TTL removes entries not restored for this many seconds.
	TTL     int64 `json:"ttl"        bun:"ttl,notnull,default:0"`
	Updated int64 `json:"updated"    bun:"updated,notnull,default:0"`

} //	@name	BuildCacheSettings

BuildCacheSettings are the cache limits an admin set for one org. They govern only entries kept in the server's storage; a bucket the org connected is limited by its owner.

func (BuildCacheSettings) TableName added in v6.12.0

func (BuildCacheSettings) TableName() string

TableName returns the database table name.

type BuildCacheSize added in v6.12.0

type BuildCacheSize struct {
	OrgID  int64 `json:"org_id"  bun:"org_id"`
	RepoID int64 `json:"repo_id" bun:"repo_id"`
	// Own is set for entries in a bucket the org connected.
	Own     bool  `json:"own"     bun:"own"`
	Size    int64 `json:"size"    bun:"size"`
	Entries int64 `json:"entries" bun:"entries"`
	Repos   int64 `json:"repos"   bun:"repos"`

} //	@name	BuildCacheSize

BuildCacheSize is the stored size of a group of cache entries.

type BuildCacheUsage added in v6.12.0

type BuildCacheUsage struct {
	bun.BaseModel `bun:"table:build_cache_usage"`

	ID     int64 `json:"-"            bun:"id,pk,autoincrement"`
	RepoID int64 `json:"repo_id"      bun:"repo_id,notnull,unique:build_cache_usage_day"`
	// OrgID is the org that owned the repo when the traffic happened.
	OrgID    int64 `json:"org_id"       bun:"org_id,notnull"`
	BucketID int64 `json:"bucket_id"    bun:"bucket_id,notnull,default:0,unique:build_cache_usage_day"`
	// Day is the start of the UTC day as a unix timestamp.
	Day int64 `json:"day"          bun:"day,notnull,unique:build_cache_usage_day"`

	BuildCacheUsageCounts

} //	@name	BuildCacheUsage

BuildCacheUsage counts the cache traffic of one repo and storage on one day.

func (BuildCacheUsage) TableName added in v6.12.0

func (BuildCacheUsage) TableName() string

TableName returns the database table name.

type BuildCacheUsageCounts added in v6.12.0

type BuildCacheUsageCounts struct {
	// Hits restored the requested key, PartialHits one of its restore keys.
	Hits        int64 `json:"hits"         bun:"hits,notnull,default:0"`
	PartialHits int64 `json:"partial_hits" bun:"partial_hits,notnull,default:0"`
	Misses      int64 `json:"misses"       bun:"misses,notnull,default:0"`
	// Denied restores found an entry but were refused by the egress limit.
	Denied int64 `json:"denied"       bun:"denied,notnull,default:0"`
	Saves  int64 `json:"saves"        bun:"saves,notnull,default:0"`
	// Egress is the bytes handed out to restore, Ingress the bytes saved.
	Egress  int64 `json:"egress"       bun:"egress,notnull,default:0"`
	Ingress int64 `json:"ingress"      bun:"ingress,notnull,default:0"`
}

BuildCacheUsageCounts are the counters of BuildCacheUsage.

func (*BuildCacheUsageCounts) Add added in v6.12.0

Add adds o to c.

type BuildCacheUsageFilter added in v6.12.0

type BuildCacheUsageFilter struct {
	OrgID  int64
	RepoID int64
	// BucketID is a bucket ID or one of the BuildCache*Storage selectors.
	BucketID int64
	// Since is the first day counted, as a unix timestamp.
	Since int64
}

BuildCacheUsageFilter narrows the usage a store query sums.

type BuildCacheUsageGroup added in v6.12.0

type BuildCacheUsageGroup struct {
	OrgID  int64 `json:"org_id,omitempty"  bun:"org_id"`
	RepoID int64 `json:"repo_id,omitempty" bun:"repo_id"`
	Day    int64 `json:"day,omitempty"     bun:"day"`
	// Own is set for the usage of a bucket the org connected.
	Own bool `json:"own"               bun:"own"`

	BuildCacheUsageCounts

} //	@name	BuildCacheUsageGroup

BuildCacheUsageGroup is the usage summed per org, repo or day, depending on the query; the other keys are zero.

type CacheEntry

type CacheEntry struct {
	bun.BaseModel `bun:"table:cache_entries"`

	Key       string `json:"key" bun:"key,pk"`
	Data      []byte `json:"data" bun:"data"`
	ExpiresAt int64  `json:"expires_at" bun:"expires_at"`
	CreatedAt int64  `json:"created_at" bun:"created_at"`
}

CacheEntry represents a distributed cache entry.

func (CacheEntry) TableName

func (CacheEntry) TableName() string

TableName returns the table name for cache entries.

type Commit

type Commit struct {
	SHA      string
	ForgeURL string
	Message  string
}

type Config

type Config struct {
	bun.BaseModel `bun:"table:configs"`

	ID     int64  `json:"-"    bun:"id,pk,autoincrement"`
	RepoID int64  `json:"-"    bun:"repo_id,unique:s"`
	Hash   string `json:"hash" bun:"hash,unique:s"`
	Name   string `json:"name" bun:"name,unique:s"`
	Data   []byte `json:"data" bun:"data"`
	// GeneratedFrom names the config this one was produced from, for configs that
	// are not fetched from the forge but computed by the server. Currently this is
	// the .jsonnet source a rendered YAML document was evaluated out of. Empty for
	// configs that came from the forge verbatim.
	//
	// Generated configs exist so the evaluated pipeline can be inspected after the
	// fact; they must never be fed back into the step builder, or the source would
	// be evaluated a second time and every workflow would be built twice.
	GeneratedFrom string `json:"generated_from,omitempty" bun:"generated_from"`

} //	@name	Config

Config represents a pipeline configuration.

func (Config) IsGenerated added in v6.10.0

func (c Config) IsGenerated() bool

IsGenerated reports whether the config was produced by the server rather than fetched from the forge.

func (Config) TableName

func (Config) TableName() string

type Cron

type Cron struct {
	bun.BaseModel `bun:"table:crons"`

	ID        int64  `json:"id"         bun:"id,pk,autoincrement"`
	Name      string `json:"name"       bun:"name,unique:s"`
	RepoID    int64  `json:"repo_id"    bun:"repo_id,unique:s"`
	CreatorID int64  `json:"creator_id" bun:"creator_id"`
	NextExec  int64  `json:"next_exec"  bun:"next_exec"`
	Schedule  string `json:"schedule"   bun:"schedule,notnull"`
	Created   int64  `json:"created"    bun:"created,notnull,default:0"`
	Branch    string `json:"branch"     bun:"branch"`
	FailCount int    `json:"fail_count" bun:"fail_count,notnull,default:0"`
	FailMsg   string `json:"fail_msg"   bun:"fail_msg,type:text"`
	Disabled  bool   `json:"disabled"   bun:"disabled,notnull,default:false"`

} //	@name	Cron

func (*Cron) BeforeAppendModel added in v6.11.0

func (c *Cron) BeforeAppendModel(_ context.Context, query bun.Query) error

func (Cron) TableName

func (Cron) TableName() string

TableName returns the database table name.

func (*Cron) Validate

func (c *Cron) Validate() error

Validate ensures cron has a valid name and schedule.

func (*Cron) WithRepo

func (c *Cron) WithRepo(repoName, repoOwner, repoDefaultBranch string, forgeID int64, forgeName, forgeIcon, forgeType string) *CronWithRepo

WithRepo creates a CronWithRepo from a Cron with repo details.

type CronWithRepo

type CronWithRepo struct {
	Cron
	RepoName          string `json:"repo_name"`
	RepoOwner         string `json:"repo_owner"`
	RepoDefaultBranch string `json:"repo_default_branch"`
	ForgeID           int64  `json:"forge_id,omitempty"`   // forge ID for multi-forge display
	ForgeName         string `json:"forge_name,omitempty"` // forge hostname for multi-forge display
	ForgeIcon         string `json:"forge_icon,omitempty"` // forge icon name/URL for multi-forge display
	ForgeType         string `json:"forge_type,omitempty"` // forge type (github, gitlab, etc.) for icon fallback
}

CronWithRepo extends Cron with repository context for user views.

type DistributedLock

type DistributedLock struct {
	bun.BaseModel `bun:"table:distributed_locks"`

	ID         int64  `json:"id"          bun:"id,pk,autoincrement"`
	Name       string `json:"name"        bun:"name,unique,notnull"`
	InstanceID string `json:"instance_id" bun:"instance_id,notnull"`
	AcquiredAt int64  `json:"acquired_at" bun:"acquired_at"`
	ExpiresAt  int64  `json:"expires_at"  bun:"expires_at"`

} //	@name	DistributedLock

DistributedLock represents a distributed lock for coordinating operations across multiple server instances in HA deployments.

func (DistributedLock) TableName

func (DistributedLock) TableName() string

TableName returns the table name for DistributedLock.

type DistributedMessage

type DistributedMessage struct {
	bun.BaseModel `bun:"table:pubsub_messages"`

	ID         string              `json:"id" bun:"id,pk"`
	Data       []byte              `json:"data" bun:"data"`
	Labels     JSONMapStringString `json:"labels" bun:"labels,type:text"`
	CreatedAt  int64               `json:"created_at" bun:"created_at"`
	InstanceID string              `json:"instance_id" bun:"instance_id"`

} //	@name	DistributedMessage

DistributedMessage represents a message stored in the database for distributed pub/sub.

func (DistributedMessage) TableName

func (DistributedMessage) TableName() string

TableName returns the database table name.

type EmailUnsubscribe

type EmailUnsubscribe struct {
	bun.BaseModel `bun:"table:email_unsubscribes"`

	ID        int64  `json:"id"         bun:"id,pk,autoincrement"`
	UserID    int64  `json:"user_id"    bun:"user_id,notnull"`
	RepoID    int64  `json:"repo_id"    bun:"repo_id,notnull"`
	Email     string `json:"email"      bun:"email,notnull"`
	CreatedAt int64  `json:"created_at" bun:",nullzero"`
}

EmailUnsubscribe records that a user has opted out of email notifications for a repo.

func (*EmailUnsubscribe) BeforeAppendModel added in v6.11.0

func (e *EmailUnsubscribe) BeforeAppendModel(_ context.Context, query bun.Query) error

type EmailUnsubscribeStore

type EmailUnsubscribeStore interface {
	EmailUnsubscribeFind(userID, repoID int64) (*EmailUnsubscribe, error)
	EmailUnsubscribeCreate(*EmailUnsubscribe) error
	EmailUnsubscribeDelete(userID, repoID int64) error
}

EmailUnsubscribeStore persists email unsubscribe records.

type Entity

type Entity struct {
	ID         int64      `json:"id"`
	EntityType EntityType `json:"entity_type"`
	Name       string     `json:"name"`
	ForgeID    int64      `json:"forge_id,omitempty"`

	// User-specific fields (nil for orgs)
	Email       *string `json:"email,omitempty"`
	Avatar      *string `json:"avatar,omitempty"`
	Admin       *bool   `json:"admin,omitempty"`
	Description *string `json:"description,omitempty"`
	Timezone    *string `json:"timezone,omitempty"`
	// Instance roles besides admin, so the admin user list can show and edit them.
	Roles []string `json:"roles,omitempty"`

	// Org-specific fields (nil for users)
	IsUser  *bool `json:"is_user,omitempty"`
	Private *bool `json:"private,omitempty"`

} //	@name	Entity

Entity represents a unified view of users and organizations for admin management.

func OrgToEntity

func OrgToEntity(org *Org) *Entity

OrgToEntity converts an Org model to an Entity.

func UserToEntity

func UserToEntity(user *User) *Entity

UserToEntity converts a User model to an Entity.

type EntityType

type EntityType string

EntityType represents the type of entity (user or organization).

const (
	EntityTypeUser EntityType = "user"
	EntityTypeOrg  EntityType = "org"
)

type Environ

type Environ struct {
	Name  string `json:"name"`
	Value string `json:"value,omitempty"`
}

Environ represents an environment variable.

func (*Environ) Copy

func (e *Environ) Copy() *Environ

Copy makes a copy of the environment variable without the value.

func (*Environ) Validate

func (e *Environ) Validate() error

Validate validates the required fields and formats.

type Event

type Event struct {
	Repo     Repo     `json:"repo"`
	Pipeline Pipeline `json:"pipeline"`
}

Event represents a pipeline event.

type EventType

type EventType string

EventType defines the possible types of pipeline events.

type ExternalSecretRef

type ExternalSecretRef struct {
	IntegrationID   int64  `json:"integration_id"   yaml:"integration_id"`
	IntegrationName string `json:"integration_name" yaml:"integration_name,omitempty"`
	Path            string `json:"path"             yaml:"path"`
	Key             string `json:"key"              yaml:"key"`
	Version         int    `json:"version"          yaml:"version,omitempty"`
}

ExternalSecretRef represents a reference to an external secret in YAML. An integration is referenced either by numeric ID or by name; name takes precedence when both are set and is resolved to an integration at fetch time.

func (*ExternalSecretRef) CacheKey

func (r *ExternalSecretRef) CacheKey() string

CacheKey returns a unique key for caching this secret. It must be stable for the lifetime of a reference, so name-based references are keyed by name (they are resolved to an ID only at fetch time, which must not change the key).

func (*ExternalSecretRef) Validate

func (r *ExternalSecretRef) Validate() error

Validate validates the external secret reference.

type ExternalSecretValue added in v6.11.0

type ExternalSecretValue struct {
	Value  string
	Events []WebhookEvent
	Images []string
}

ExternalSecretValue is a secret fetched through an integration, together with the usage filters of that integration, so the pipeline compiler can enforce them per step like it does for internal secrets.

type Feed

type Feed struct {
	RepoID   int64  `json:"repo_id"                 bun:"repo_id"`
	ID       int64  `json:"id,omitempty"            bun:"pipeline_id"`
	Number   int64  `json:"number,omitempty"        bun:"pipeline_number"`
	Event    string `json:"event,omitempty"         bun:"pipeline_event"`
	Status   string `json:"status,omitempty"        bun:"pipeline_status"`
	Created  int64  `json:"created,omitempty"       bun:"pipeline_created"`
	Started  int64  `json:"started,omitempty"       bun:"pipeline_started"`
	Finished int64  `json:"finished,omitempty"      bun:"pipeline_finished"`
	Commit   string `json:"commit,omitempty"        bun:"pipeline_commit"`
	Branch   string `json:"branch,omitempty"        bun:"pipeline_branch"`
	Ref      string `json:"ref,omitempty"           bun:"pipeline_ref"`
	Refspec  string `json:"refspec,omitempty"       bun:"pipeline_refspec"`
	Title    string `json:"title,omitempty"         bun:"pipeline_title"`
	Message  string `json:"message,omitempty"       bun:"pipeline_message"`
	Author   string `json:"author,omitempty"        bun:"pipeline_author"`
	Avatar   string `json:"author_avatar,omitempty" bun:"pipeline_avatar"`
	Email    string `json:"author_email,omitempty"  bun:"pipeline_email"`

} //	@name	Feed

Feed represents an item in the user's feed or timeline.

type Forge

type Forge struct {
	bun.BaseModel `bun:"table:forges"`

	ID                int64            `json:"id"                           bun:"id,pk,autoincrement"`
	Type              ForgeType        `json:"type"                         bun:"type,type:varchar(250)"`
	URL               string           `json:"url"                          bun:"url,type:varchar(500)"`
	Client            string           `json:"client,omitempty"             bun:"client,type:varchar(250)"`
	ClientSecret      string           `json:"-"                            bun:"client_secret,type:varchar(250)"`
	SkipVerify        bool             `json:"skip_verify,omitempty"        bun:"skip_verify"`
	OAuthHost         string           `json:"oauth_host,omitempty"         bun:"oauth_host,type:varchar(250)"`
	Icon              string           `json:"icon,omitempty"               bun:"icon,type:varchar(250)"`
	AdditionalOptions JSONMapStringAny `json:"additional_options,omitempty" bun:"additional_options,type:text"`

} //	@name	Forge

func (*Forge) PublicCopy

func (f *Forge) PublicCopy() *Forge

PublicCopy returns a copy of the forge without sensitive information and technical details.

func (Forge) TableName

func (Forge) TableName() string

TableName returns the database table name.

type ForgeRemoteID

type ForgeRemoteID string

func (ForgeRemoteID) IsValid

func (r ForgeRemoteID) IsValid() bool

type ForgeType

type ForgeType string
const (
	ForgeTypeGithub              ForgeType = "github"
	ForgeTypeGitlab              ForgeType = "gitlab"
	ForgeTypeGitea               ForgeType = "gitea"
	ForgeTypeForgejo             ForgeType = "forgejo"
	ForgeTypeBitbucket           ForgeType = "bitbucket"
	ForgeTypeBitbucketDatacenter ForgeType = "bitbucket-dc"
	ForgeTypeAddon               ForgeType = "addon"
)

type InfisicalConfig

type InfisicalConfig struct {
	SiteURL      string `json:"site_url"`      // Infisical instance URL (e.g., https://app.infisical.com)
	ClientID     string `json:"client_id"`     // Machine Identity Client ID
	ClientSecret string `json:"client_secret"` // Machine Identity Client Secret
	ProjectID    string `json:"project_id"`    // Infisical Project ID
	Environment  string `json:"environment"`   // Environment slug (e.g., dev, staging, prod)
	SecretPath   string `json:"secret_path"`   // Secret path/folder (default: "/")
}

InfisicalConfig holds Infisical specific configuration.

func (*InfisicalConfig) Redacted

func (c *InfisicalConfig) Redacted() *InfisicalConfig

Redacted returns a copy with sensitive fields redacted.

func (*InfisicalConfig) Validate

func (c *InfisicalConfig) Validate() error

Validate validates the Infisical configuration.

func (*InfisicalConfig) WithDefaults

func (c *InfisicalConfig) WithDefaults() *InfisicalConfig

WithDefaults returns a copy with default values applied.

type Integration

type Integration struct {
	bun.BaseModel `bun:"table:integrations"`

	ID          int64           `json:"id"           bun:"id,pk,autoincrement"`
	UserID      int64           `json:"user_id"      bun:"user_id,notnull"`
	Name        string          `json:"name"         bun:"name,notnull,type:varchar(255)"`
	Type        IntegrationType `json:"type"         bun:"type,notnull,type:varchar(50)"`
	Description string          `json:"description"  bun:"description,type:text"`

	// Configuration (provider-specific, encrypted in storage)
	Config string `json:"config,omitempty" bun:"config,type:text"`

	// Access Control - who can use this integration
	AllowedUserIDs JSONSliceInt64 `json:"allowed_user_ids" bun:"allowed_user_ids,type:text"`
	AllowedOrgIDs  JSONSliceInt64 `json:"allowed_org_ids"  bun:"allowed_org_ids,type:text"`
	AllowedRepoIDs JSONSliceInt64 `json:"allowed_repo_ids" bun:"allowed_repo_ids,type:text"`

	// Usage filters applied to every secret fetched through this integration,
	// equivalent to the events and images filters of internal secrets.
	// Empty Events means DefaultIntegrationEvents; empty Images means any step.
	Events JSONSliceWebhookEvent `json:"events" bun:"events,type:text"`
	Images JSONSliceString       `json:"images" bun:"images,type:text"`

	// Status
	IsActive bool `json:"is_active" bun:"is_active,default:true"`

	// Metadata
	CreatedAt int64 `json:"created_at" bun:",nullzero"`
	UpdatedAt int64 `json:"updated_at" bun:",nullzero"`

} //	@name	Integration

Integration represents an external secret store integration.

func (*Integration) AllowedEvents added in v6.11.0

func (i *Integration) AllowedEvents() []WebhookEvent

AllowedEvents returns the pipeline events this integration serves secrets to.

func (*Integration) AllowsEvent added in v6.11.0

func (i *Integration) AllowsEvent(event WebhookEvent) bool

AllowsEvent reports whether secrets of this integration may be used by a pipeline triggered by event. Like internal secrets, the pull request close, merge and edit events count as pull_request.

func (*Integration) BeforeAppendModel added in v6.11.0

func (i *Integration) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*Integration) BeforeInsert

func (i *Integration) BeforeInsert()

BeforeInsert sets defaults before insertion.

func (*Integration) Copy

func (i *Integration) Copy() *Integration

Copy returns a copy of the integration without sensitive configuration.

func (*Integration) CopyWithRedactedConfig

func (i *Integration) CopyWithRedactedConfig() *Integration

CopyWithRedactedConfig returns a copy with configuration redacted for display.

func (*Integration) GetAzureKeyVaultConfig

func (i *Integration) GetAzureKeyVaultConfig() (*AzureKeyVaultConfig, error)

GetAzureKeyVaultConfig parses and returns the Azure Key Vault configuration.

func (*Integration) GetInfisicalConfig

func (i *Integration) GetInfisicalConfig() (*InfisicalConfig, error)

GetInfisicalConfig parses and returns the Infisical configuration.

func (*Integration) GetVaultConfig

func (i *Integration) GetVaultConfig() (*VaultConfig, error)

GetVaultConfig parses and returns the Vault configuration.

func (*Integration) HasAccess

func (i *Integration) HasAccess(userID int64, orgID int64, repoID int64) bool

HasAccess checks if the given user/org/repo has access to use this integration. Access is explicitly granted via allowlists - if no allowlists are configured, no one can use the integration (owner can still manage it, but not use it for secrets).

func (*Integration) SetAzureKeyVaultConfig

func (i *Integration) SetAzureKeyVaultConfig(config *AzureKeyVaultConfig) error

SetAzureKeyVaultConfig sets the Azure Key Vault configuration.

func (*Integration) SetInfisicalConfig

func (i *Integration) SetInfisicalConfig(config *InfisicalConfig) error

SetInfisicalConfig sets the Infisical configuration.

func (*Integration) SetVaultConfig

func (i *Integration) SetVaultConfig(config *VaultConfig) error

SetVaultConfig sets the Vault configuration.

func (Integration) TableName

func (Integration) TableName() string

TableName returns the database table name.

func (*Integration) Validate

func (i *Integration) Validate() error

Validate validates the integration fields.

type IntegrationStore

type IntegrationStore interface {
	IntegrationFind(int64) (*Integration, error)
	IntegrationFindByName(userID int64, name string) (*Integration, error)
	IntegrationList(userID int64, opts *ListOptions) ([]*Integration, error)
	IntegrationListAll(opts *ListOptions) ([]*Integration, error)
	IntegrationListAccessible(userID int64, orgIDs []int64, repoIDs []int64, opts *ListOptions) ([]*Integration, error)
	IntegrationCreate(*Integration) error
	IntegrationUpdate(*Integration) error
	IntegrationDelete(*Integration) error
}

IntegrationStore persists integration information to storage.

type IntegrationType

type IntegrationType string

IntegrationType represents the type of external integration.

const (
	IntegrationTypeVault         IntegrationType = "vault"
	IntegrationTypeAzureKeyVault IntegrationType = "azure_key_vault"
	IntegrationTypeInfisical     IntegrationType = "infisical"
)

func (IntegrationType) IsValid

func (t IntegrationType) IsValid() bool

IsValid checks if the integration type is valid.

type JSONMapStringAny

type JSONMapStringAny map[string]any

JSONMapStringAny is a map[string]any that serializes to/from JSON in the database.

func (*JSONMapStringAny) Scan

func (j *JSONMapStringAny) Scan(src any) error

func (JSONMapStringAny) Value

func (j JSONMapStringAny) Value() (driver.Value, error)

type JSONMapStringStatusValue

type JSONMapStringStatusValue map[string]StatusValue

JSONMapStringStatusValue is a map[string]StatusValue that serializes to/from JSON in the database.

func (*JSONMapStringStatusValue) Scan

func (j *JSONMapStringStatusValue) Scan(src any) error

func (JSONMapStringStatusValue) Value

type JSONMapStringString

type JSONMapStringString map[string]string

JSONMapStringString is a map[string]string that serializes to/from JSON in the database.

func (*JSONMapStringString) Scan

func (j *JSONMapStringString) Scan(src any) error

func (JSONMapStringString) Value

func (j JSONMapStringString) Value() (driver.Value, error)

type JSONSliceInt64

type JSONSliceInt64 []int64

JSONSliceInt64 is a []int64 that serializes to/from JSON in the database.

func (JSONSliceInt64) MarshalJSON added in v6.3.0

func (j JSONSliceInt64) MarshalJSON() ([]byte, error)

func (*JSONSliceInt64) Scan

func (j *JSONSliceInt64) Scan(src any) error

func (JSONSliceInt64) Value

func (j JSONSliceInt64) Value() (driver.Value, error)

type JSONSliceNotificationEvent

type JSONSliceNotificationEvent []NotificationEvent

JSONSliceNotificationEvent is a []NotificationEvent that serializes to/from JSON in the database.

func (JSONSliceNotificationEvent) MarshalJSON added in v6.3.0

func (j JSONSliceNotificationEvent) MarshalJSON() ([]byte, error)

func (*JSONSliceNotificationEvent) Scan

func (j *JSONSliceNotificationEvent) Scan(src any) error

func (JSONSliceNotificationEvent) Value

type JSONSlicePipelineError

type JSONSlicePipelineError []*types.PipelineError

JSONSlicePipelineError is a []*types.PipelineError that serializes to/from JSON in the database.

func (JSONSlicePipelineError) MarshalJSON added in v6.3.0

func (j JSONSlicePipelineError) MarshalJSON() ([]byte, error)

func (*JSONSlicePipelineError) Scan

func (j *JSONSlicePipelineError) Scan(src any) error

func (JSONSlicePipelineError) Value

type JSONSliceProvisioningPhase added in v6.12.0

type JSONSliceProvisioningPhase []ProvisioningPhase

JSONSliceProvisioningPhase is a JSON-serialized []ProvisioningPhase.

func (JSONSliceProvisioningPhase) MarshalJSON added in v6.12.0

func (j JSONSliceProvisioningPhase) MarshalJSON() ([]byte, error)

func (*JSONSliceProvisioningPhase) Scan added in v6.12.0

func (j *JSONSliceProvisioningPhase) Scan(src any) error

func (JSONSliceProvisioningPhase) Value added in v6.12.0

type JSONSliceString

type JSONSliceString []string

JSONSliceString is a []string that serializes to/from JSON in the database.

func RolesToStrings added in v6.11.0

func RolesToStrings(roles []Role) JSONSliceString

RolesToStrings converts roles for storage in User.Roles.

func (JSONSliceString) MarshalJSON added in v6.3.0

func (j JSONSliceString) MarshalJSON() ([]byte, error)

func (*JSONSliceString) Scan

func (j *JSONSliceString) Scan(src any) error

func (JSONSliceString) Value

func (j JSONSliceString) Value() (driver.Value, error)

type JSONSliceWebhookEvent

type JSONSliceWebhookEvent []WebhookEvent

JSONSliceWebhookEvent is a []WebhookEvent that serializes to/from JSON in the database.

func (JSONSliceWebhookEvent) MarshalJSON added in v6.3.0

func (j JSONSliceWebhookEvent) MarshalJSON() ([]byte, error)

func (*JSONSliceWebhookEvent) Scan

func (j *JSONSliceWebhookEvent) Scan(src any) error

func (JSONSliceWebhookEvent) Value

func (j JSONSliceWebhookEvent) Value() (driver.Value, error)

type ListOptions

type ListOptions struct {
	All     bool
	Page    int
	PerPage int
}

type LogEntry

type LogEntry struct {
	bun.BaseModel `bun:"table:log_entries"`

	ID      int64        `json:"id"       bun:"id,pk,autoincrement"`
	StepID  int64        `json:"step_id"  bun:"step_id,unique:log_entries_step_id_line"`
	Time    int64        `json:"time"     bun:"time"`
	Line    int          `json:"line"     bun:"line,unique:log_entries_step_id_line"`
	Data    []byte       `json:"data"     bun:"data,type:bytea"`
	Created int64        `json:"-"        bun:",nullzero"`
	Type    LogEntryType `json:"type"     bun:"type"`

} //	@name	LogEntry

func (*LogEntry) BeforeAppendModel added in v6.11.0

func (l *LogEntry) BeforeAppendModel(_ context.Context, query bun.Query) error

func (LogEntry) TableName

func (LogEntry) TableName() string

type LogEntryType

type LogEntryType int //	@name	LogEntryType

LogEntryType identifies the type of line in the logs.

const (
	LogEntryStdout LogEntryType = iota
	LogEntryStderr
	LogEntryExitCode
	LogEntryMetadata
	LogEntryProgress
)

type MaintenanceConfig

type MaintenanceConfig struct {
	bun.BaseModel `bun:"table:maintenance_config"`

	ID         int64  `json:"id"       bun:"id,pk,autoincrement"`
	ActionType string `json:"action_type" bun:"action_type,unique"`
	Enabled    bool   `json:"enabled"  bun:"enabled"`
	Schedule   string `json:"schedule" bun:"schedule"`
	DryRun     bool   `json:"dry_run" bun:"dry_run,default:false"`
	// Action-specific statistics
	TotalRuns       int64     `json:"total_runs" bun:"total_runs,default:0"`
	SuccessfulRuns  int64     `json:"successful_runs" bun:"successful_runs,default:0"`
	LastRun         time.Time `json:"last_run" bun:"last_run"`
	LastRunSuccess  bool      `json:"last_run_success" bun:"last_run_success,default:false"`
	LastRunDuration int64     `json:"last_run_duration" bun:"last_run_duration,default:0"`
	LastRunError    string    `json:"last_run_error" bun:"last_run_error"`
	Created         int64     `json:"created"  bun:",nullzero"`
	Updated         int64     `json:"updated"  bun:",nullzero"`
	StaleThreshold  int64     `json:"stale_threshold" bun:"stale_threshold,default:3600"`
	// Runtime flags (not persisted)
	KubernetesCleanupAvailable bool `json:"kubernetes_cleanup_available" bun:"-"`
	DockerCleanupAvailable     bool `json:"docker_cleanup_available" bun:"-"`
	// Environment variable override flags (not persisted)
	EnvVarsSet bool `json:"env_vars_set" bun:"-"`

} //	@name	MaintenanceConfig

MaintenanceConfig represents the configuration for database maintenance operations.

func (MaintenanceConfig) TableName

func (MaintenanceConfig) TableName() string

type MaintenanceLog

type MaintenanceLog struct {
	bun.BaseModel `bun:"table:maintenance_logs"`

	ID       int64     `json:"id"       bun:"id,pk,autoincrement"`
	RunTime  time.Time `json:"run_time" bun:"run_time"`
	Success  bool      `json:"success"  bun:"success"`
	Error    string    `json:"error"    bun:"error"`
	Duration int64     `json:"duration" bun:"duration"`
	Details  string    `json:"details"  bun:"details"`
	Created  int64     `json:"created"  bun:",nullzero"`

} //	@name	MaintenanceLog

MaintenanceLog represents a log entry for maintenance operations.

func (MaintenanceLog) TableName

func (MaintenanceLog) TableName() string

type MaintenanceOperationConfig

type MaintenanceOperationConfig struct {
	bun.BaseModel `bun:"table:maintenance_operation_config"`

	ID        int64     `json:"id"         bun:"id,pk,autoincrement"`
	Operation string    `json:"operation"  bun:"operation,unique"`
	Enabled   bool      `json:"enabled"    bun:"enabled"`
	Schedule  string    `json:"schedule"   bun:"schedule"`
	TotalRuns int64     `json:"total_runs" bun:"total_runs"`
	LastRun   time.Time `json:"last_run"   bun:"last_run"`
	Created   int64     `json:"created"    bun:",nullzero"`
	Updated   int64     `json:"updated"    bun:",nullzero"`

} //	@name	MaintenanceOperationConfig

MaintenanceOperationConfig represents the configuration for individual maintenance operations.

func (MaintenanceOperationConfig) TableName

func (MaintenanceOperationConfig) TableName() string

type MaintenanceStats

type MaintenanceStats struct {
	bun.BaseModel `bun:"table:maintenance_stats"`

	ID              int64     `json:"id"              bun:"id,pk,autoincrement"`
	LastRun         time.Time `json:"last_run"        bun:"last_run"`
	LastRunSuccess  bool      `json:"last_run_success" bun:"last_run_success"`
	LastRunError    string    `json:"last_run_error"  bun:"last_run_error"`
	LastRunDuration int64     `json:"last_run_duration" bun:"last_run_duration"`
	TotalRuns       int64     `json:"total_runs"      bun:"total_runs"`
	SuccessfulRuns  int64     `json:"successful_runs" bun:"successful_runs"`
	Created         int64     `json:"created"         bun:",nullzero"`
	Updated         int64     `json:"updated"         bun:",nullzero"`

} //	@name	MaintenanceStats

MaintenanceStats represents statistics about maintenance operations.

func (MaintenanceStats) TableName

func (MaintenanceStats) TableName() string

type MetricPoint added in v6.2.0

type MetricPoint struct {
	Key   string  `json:"key"`          // stable sort/identity key (id or bucket label)
	ID    int64   `json:"id,omitempty"` // numeric id for org/repo dimensions
	Label string  `json:"label"`        // display name
	Value float64 `json:"value"`

} //	@name	MetricPoint

MetricPoint is one bar/point in a MetricSeries.

type MetricQueryOptions added in v6.2.0

type MetricQueryOptions struct {
	Dimension string
	Metric    string
	Bucket    string // day|week|month, time dimension only
	After     int64
	Before    int64
	RepoIDs   []int64 // already access-scoped by the API layer
}

MetricQueryOptions is the validated, access-scoped input to GetMetricSeries.

type MetricSeries added in v6.2.0

type MetricSeries struct {
	Dimension string        `json:"dimension"`        // org|repo|agent|time
	Metric    string        `json:"metric"`           // pipeline_count|workflow_count|avg_build_time|total_build_time|avg_steps
	Bucket    string        `json:"bucket,omitempty"` // day|week|month (time dimension only)
	Unit      string        `json:"unit"`             // count|seconds
	Points    []MetricPoint `json:"points"`

} //	@name	MetricSeries

MetricSeries is the generic result of a chart-builder query.

type Metrics

type Metrics struct {
	TotalRepos       int64            `json:"total_repos"`
	TotalOrgs        int64            `json:"total_orgs"`
	TotalPipelines   int64            `json:"total_pipelines"`
	AvgBuildTime     float64          `json:"avg_build_time"` // in seconds
	AvgStepsPerFlow  float64          `json:"avg_steps_per_flow"`
	PipelinesByRepo  map[string]int64 `json:"pipelines_by_repo"`  // repo name -> count
	PipelinesByOrg   map[string]int64 `json:"pipelines_by_org"`   // org name -> count
	WorkflowsByAgent map[string]int64 `json:"workflows_by_agent"` // agent name -> count
	RepoDetails      []RepoMetric     `json:"repo_details"`
	OrgDetails       []OrgMetric      `json:"org_details"`
	AgentDetails     []AgentMetric    `json:"agent_details"`
	IsAdminScope     bool             `json:"is_admin_scope"` // true if showing all instance metrics
}

Metrics represents overall system metrics.

type MetricsTimeFilter

type MetricsTimeFilter struct {
	After  int64 `json:"after,omitempty"`  // Unix timestamp
	Before int64 `json:"before,omitempty"` // Unix timestamp
}

MetricsTimeFilter represents time-based filtering for metrics queries.

type Netrc

type Netrc struct {
	Machine  string    `json:"machine"`
	Login    string    `json:"login"`
	Password string    `json:"password"`
	Type     ForgeType `json:"type"`
}

type NotificationConfig

type NotificationConfig struct {
	bun.BaseModel `bun:"table:notification_configs"`

	ID        int64                      `json:"id"         bun:"id,pk,autoincrement"`
	RepoID    int64                      `json:"repo_id"    bun:"repo_id,notnull,unique"`
	IsEnabled bool                       `json:"is_enabled" bun:"is_enabled,default:true"`
	Events    JSONSliceNotificationEvent `json:"events"     bun:"events,type:text"`
	CreatedAt int64                      `json:"created_at" bun:",nullzero"`
	UpdatedAt int64                      `json:"updated_at" bun:",nullzero"`

} //	@name	NotificationConfig

NotificationConfig stores per-repo email notification settings.

func (*NotificationConfig) BeforeAppendModel added in v6.11.0

func (n *NotificationConfig) BeforeAppendModel(_ context.Context, query bun.Query) error

func (NotificationConfig) TableName

func (NotificationConfig) TableName() string

TableName returns the database table name.

type NotificationConfigStore

type NotificationConfigStore interface {
	NotificationConfigFind(repoID int64) (*NotificationConfig, error)
	NotificationConfigUpsert(*NotificationConfig) error
	NotificationConfigDelete(repoID int64) error
}

NotificationConfigStore persists notification configuration to storage.

type NotificationEvent

type NotificationEvent string

NotificationEvent represents when a notification should be sent.

const (
	NotificationEventSuccess      NotificationEvent = "success"
	NotificationEventFailure      NotificationEvent = "failure"
	NotificationEventStatusChange NotificationEvent = "status_change"
)

type NotifyYAMLConfig

type NotifyYAMLConfig struct {
	Disabled bool                `json:"disabled,omitempty" yaml:"disabled,omitempty"`
	Events   []NotificationEvent `json:"events,omitempty"   yaml:"events,omitempty"`
}

NotifyYAMLConfig represents per-pipeline notification overrides from .crow.yml.

func (*NotifyYAMLConfig) Scan

func (n *NotifyYAMLConfig) Scan(src any) error

func (NotifyYAMLConfig) Value

func (n NotifyYAMLConfig) Value() (driver.Value, error)

type Org

type Org struct {
	bun.BaseModel `bun:"table:orgs"`

	ID      int64  `json:"id,omitempty"       bun:"id,pk,autoincrement"`
	ForgeID int64  `json:"forge_id,omitempty" bun:"forge_id,unique:s"`
	Name    string `json:"name"               bun:"name,unique:s"`
	IsUser  bool   `json:"is_user"            bun:"is_user"`
	// if name lookup has to check for membership or not
	Private bool `json:"-"                    bun:"private"`

} //	@name	Org

Org represents an organization.

func (Org) TableName

func (Org) TableName() string

TableName returns the database table name.

type OrgMetric

type OrgMetric struct {
	OrgID          int64   `json:"org_id"`
	OrgName        string  `json:"org_name"`
	PipelineCount  int64   `json:"pipeline_count"`
	RepoCount      int64   `json:"repo_count"`
	AvgBuildTime   float64 `json:"avg_build_time"`   // in seconds
	TotalBuildTime float64 `json:"total_build_time"` // in seconds
}

OrgMetric represents metrics for a specific organization.

type OrgMetricData added in v6.2.0

type OrgMetricData struct {
	OrgID         int64
	OrgName       string
	PipelineCount int64
	RepoCount     int64
}

OrgMetricData holds aggregated pipeline data for an org, with the display name carried straight from the denormalized pipeline rows so it survives org deletion and covers personal-account orgs.

type OrgPerm

type OrgPerm struct {
	Member bool `json:"member"`
	Admin  bool `json:"admin"`

} //	@name	OrgPerm

OrgPerm defines an organization permission for an individual user.

type Perm

type Perm struct {
	bun.BaseModel `bun:"table:perms"`

	UserID  int64 `json:"-"       bun:"user_id,notnull,unique:s"`
	RepoID  int64 `json:"-"       bun:"repo_id,notnull,unique:s"`
	Repo    *Repo `json:"-"       bun:"-"`
	Pull    bool  `json:"pull"    bun:"pull"`
	Push    bool  `json:"push"    bun:"push"`
	Admin   bool  `json:"admin"   bun:"admin"`
	Synced  int64 `json:"synced"  bun:"synced"`
	Created int64 `json:"created" bun:",nullzero"`
	Updated int64 `json:"updated" bun:",nullzero"`

} //	@name	Perm

Perm defines a repository permission for an individual user.

func (*Perm) BeforeAppendModel added in v6.11.0

func (p *Perm) BeforeAppendModel(_ context.Context, query bun.Query) error

func (Perm) TableName

func (Perm) TableName() string

TableName returns the database table name.

type Permission added in v6.11.0

type Permission string

Permission is an instance-level action guarded by a role.

const (
	PermUsersRead        Permission = "users:read"
	PermUsersWrite       Permission = "users:write"
	PermOrgsRead         Permission = "orgs:read"
	PermOrgsDelete       Permission = "orgs:delete"
	PermReposRead        Permission = "repos:read"
	PermReposRepair      Permission = "repos:repair"
	PermQueueRead        Permission = "queue:read"
	PermQueueWrite       Permission = "queue:write"
	PermAgentsRead       Permission = "agents:read"
	PermAgentsRegister   Permission = "agents:register"
	PermAgentsWrite      Permission = "agents:write"
	PermSecretsWrite     Permission = "secrets:write"
	PermMaintenanceRead  Permission = "maintenance:read"
	PermMaintenanceWrite Permission = "maintenance:write"
	PermMetricsAll       Permission = "metrics:all"
	PermServerAdmin      Permission = "server:admin"
)

func AllPermissions added in v6.11.0

func AllPermissions() []Permission

AllPermissions returns every permission, sorted.

type Pipeline

type Pipeline struct {
	bun.BaseModel `bun:"table:pipelines"`

	ID     int64 `json:"id"                      bun:"id,pk,autoincrement"`
	RepoID int64 `json:"-"                       bun:"repo_id,unique:s"`
	// OrgID, OrgName and RepoFullName are denormalized from the owning repo at
	// creation time so historic metrics survive repo/org renames and deletion
	// (mirroring the agent identity denormalized onto workflows).
	OrgID               int64                  `json:"-"                       bun:"org_id"`
	OrgName             string                 `json:"-"                       bun:"org_name,type:text"`
	RepoFullName        string                 `json:"-"                       bun:"repo_full_name,type:text"`
	Number              int64                  `json:"number"                  bun:"number,unique:s"`
	Author              string                 `json:"author"                  bun:"author"`
	Parent              int64                  `json:"parent"                  bun:"parent"`
	Event               WebhookEvent           `json:"event"                   bun:"event"`
	Status              StatusValue            `json:"status"                  bun:"status"`
	Errors              JSONSlicePipelineError `json:"errors"                  bun:"errors,type:text"`
	Created             int64                  `json:"created"                 bun:"created,notnull,default:0"`
	Updated             int64                  `json:"updated"                 bun:"updated,notnull,default:0"`
	Started             int64                  `json:"started"                 bun:"started"`
	Finished            int64                  `json:"finished"                bun:"finished"`
	DeployTo            string                 `json:"deploy_to"               bun:"deploy"`
	DeployTask          string                 `json:"deploy_task"             bun:"deploy_task"`
	Commit              string                 `json:"commit"                  bun:"commit"`
	Branch              string                 `json:"branch"                  bun:"branch"`
	Ref                 string                 `json:"ref"                     bun:"ref"`
	Refspec             string                 `json:"refspec"                 bun:"refspec"`
	Title               string                 `json:"title"                   bun:"title"`
	Message             string                 `json:"message"                 bun:"message,type:text"`
	Timestamp           int64                  `json:"timestamp"               bun:"timestamp"`
	Sender              string                 `json:"sender"                  bun:"sender"`
	Avatar              string                 `json:"author_avatar"           bun:"avatar,type:varchar(500)"`
	Email               string                 `json:"author_email"            bun:"email,type:varchar(500)"`
	ForgeURL            string                 `json:"forge_url"               bun:"forge_url"`
	Reviewer            string                 `json:"reviewed_by"             bun:"reviewer"`
	Reviewed            int64                  `json:"reviewed"                bun:"reviewed"`
	Workflows           []*Workflow            `json:"workflows,omitempty"     bun:"-"`
	ChangedFiles        JSONSliceString        `json:"changed_files,omitempty" bun:"changed_files,type:text"`
	AdditionalVariables JSONMapStringString    `json:"variables,omitempty"     bun:"additional_variables,type:text"`
	PullRequestLabels   JSONSliceString        `json:"pr_labels,omitempty"     bun:"pr_labels,type:text"`
	IsPrerelease        bool                   `json:"is_prerelease,omitempty" bun:"is_prerelease"`
	FromFork            bool                   `json:"from_fork,omitempty"     bun:"from_fork"`
	LogsDeleted         bool                   `json:"logs_deleted,omitempty"  bun:"logs_deleted"`
	IsAlwaysApproved    bool                   `json:"is_always_approved,omitempty" bun:"-"`
	NotifyOverride      *NotifyYAMLConfig      `json:"notify_override,omitempty"   bun:"notify_override,type:text"`

} //	@name	Pipeline

func (*Pipeline) BeforeAppendModel added in v6.11.0

func (p *Pipeline) BeforeAppendModel(_ context.Context, query bun.Query) error

func (Pipeline) IsMultiPipeline

func (p Pipeline) IsMultiPipeline() bool

IsMultiPipeline checks if step list contain more than one parent step.

func (Pipeline) TableName

func (Pipeline) TableName() string

TableName returns the database table name.

type PipelineConfig

type PipelineConfig struct {
	bun.BaseModel `bun:"table:pipeline_configs"`

	ConfigID   int64 `json:"-"   bun:"config_id,notnull,unique:s"`
	PipelineID int64 `json:"-"   bun:"pipeline_id,notnull,unique:s"`
}

PipelineConfig is the n:n relation between Pipeline and Config.

func (PipelineConfig) TableName

func (PipelineConfig) TableName() string

type PipelineFilter

type PipelineFilter struct {
	Before        int64
	After         int64
	Branch        string
	Events        []WebhookEvent
	RefContains   string
	Status        StatusValue
	Search        string   // Search query for number, message, branch, author
	WorkflowNames []string // Filter by workflow names (matches any)
}

type PipelineOptions

type PipelineOptions struct {
	Branch    string            `json:"branch"`
	Ref       string            `json:"ref,omitempty"` // defaults to Branch; set to refs/tags/<tag> for a run against a tag
	Variables map[string]string `json:"variables"`
	Workflows []string          `json:"workflows,omitempty"` // specific workflows to run (if empty, all matching workflows are run)

} //	@name	PipelineOptions

type ProcLogEntry

type ProcLogEntry struct {
	bun.BaseModel `bun:"table:proc_log_entries"`

	ID         int64  `json:"id"          bun:"id,pk,autoincrement"`
	SourceType string `json:"source_type" bun:"source_type,notnull"`
	SourceID   int64  `json:"source_id"   bun:"source_id,notnull"`
	// Time is Unix nanoseconds; set by the producer.
	Time  int64  `json:"time"        bun:"time,notnull"`
	Level string `json:"level"       bun:"level,notnull"`
	Line  string `json:"line"        bun:"line,notnull"`
}

ProcLogEntry is one process-log line shipped by an agent or autoscaler. Indexed by (source_type, source_id, id) for tail queries.

func (ProcLogEntry) TableName

func (ProcLogEntry) TableName() string

type ProcLogSourceKey

type ProcLogSourceKey struct {
	SourceType string `bun:"source_type"`
	SourceID   int64  `bun:"source_id"`
}

ProcLogSourceKey identifies a unique log source. The bun column tags allow scanning DISTINCT source_type, source_id results from ProcLogListSources directly into this struct.

type ProvisioningAgent added in v6.12.0

type ProvisioningAgent struct {
	ID     int64               `json:"id"`
	Name   string              `json:"name"`
	Phases []ProvisioningPhase `json:"phases"`

} //	@name	ProvisioningAgent

ProvisioningAgent is an agent being provisioned for a pending workflow. Phases leave out the hosts' free-text details, which are only returned with the agent.

type ProvisioningPhase added in v6.12.0

type ProvisioningPhase struct {
	Phase string `json:"phase"`
	// Detail is free text from the host, for example the error of a failed
	// phase. It is only returned with the agent, never with workflows.
	Detail string `json:"detail,omitempty"`
	Failed bool   `json:"failed,omitempty"`
	At     int64  `json:"at"`

} //	@name	ProvisioningPhase

ProvisioningPhase is one step a host reported while being set up to run an agent, such as installing a hypervisor or building a base image.

type PullRequest

type PullRequest struct {
	Index ForgeRemoteID `json:"index"`
	Title string        `json:"title"`

} //	@name	PullRequest

type QueueInfo

type QueueInfo struct {
	Pending       []QueueTask `json:"pending"`
	WaitingOnDeps []QueueTask `json:"waiting_on_deps"`
	Running       []QueueTask `json:"running"`
	Stats         struct {
		WorkerCount        int `json:"worker_count"`
		PendingCount       int `json:"pending_count"`
		WaitingOnDepsCount int `json:"waiting_on_deps_count"`
		RunningCount       int `json:"running_count"`
	} `json:"stats"`
	Paused bool `json:"paused"`

} //	@name	QueueInfo

QueueInfo represents the response structure for queue information API.

type QueueTask

type QueueTask struct {
	Task
	PipelineNumber  int64  `json:"pipeline_number"`
	AgentName       string `json:"agent_name"`
	PipelineCreated int64  `json:"pipeline_created"` // Unix timestamp when the pipeline was created
	PipelineStarted int64  `json:"pipeline_started"` // Unix timestamp when the pipeline started running (0 if not started)
}

QueueTask represents a task in the queue with additional API-specific fields.

type Redirection

type Redirection struct {
	bun.BaseModel `bun:"table:redirections"`

	ID       int64  `bun:"id,pk,autoincrement"`
	ForgeID  int64  `bun:"forge_id,unique:forge"`
	RepoID   int64  `bun:"repo_id"`
	FullName string `bun:"repo_full_name,unique:forge"`
}

func (Redirection) TableName

func (r Redirection) TableName() string

type Registry

type Registry struct {
	bun.BaseModel `bun:"table:registries"`

	ID        int64  `json:"id"         bun:"id,pk,autoincrement"`
	OrgID     int64  `json:"org_id"     bun:"org_id,notnull,default:0,unique:s"`
	RepoID    int64  `json:"repo_id"    bun:"repo_id,notnull,default:0,unique:s"`
	Address   string `json:"address"    bun:"address,notnull,unique:s"`
	Username  string `json:"username"   bun:"username,type:varchar(2000)"`
	Password  string `json:"password"   bun:"password,type:text"`
	ReadOnly  bool   `json:"readonly"   bun:"-"`
	CreatedAt int64  `json:"created_at" bun:",nullzero"`
	UpdatedAt int64  `json:"updated_at" bun:",nullzero"`

} //	@name	Registry

Registry represents a docker registry with credentials.

func (*Registry) BeforeAppendModel added in v6.11.0

func (r *Registry) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*Registry) Copy

func (r *Registry) Copy() *Registry

Copy makes a copy of the registry without the password.

func (Registry) IsGlobal

func (r Registry) IsGlobal() bool

Global registry.

func (Registry) IsOrganization

func (r Registry) IsOrganization() bool

Organization registry.

func (Registry) IsRepository

func (r Registry) IsRepository() bool

Repository registry.

func (Registry) TableName

func (r Registry) TableName() string

func (*Registry) Validate

func (r *Registry) Validate() error

Validate validates the registry information.

func (*Registry) WithOrg

func (r *Registry) WithOrg(orgName string, isPersonalOrg bool, forgeID int64, forgeName, forgeIcon, forgeType string) *RegistryWithOrg

WithOrg creates a RegistryWithOrg from a Registry with the given org name.

type RegistryWithOrg

type RegistryWithOrg struct {
	Registry
	OrgName   string `json:"org_name"`
	ScopeType string `json:"scope_type"`           // "user", "org", or "global"
	ForgeID   int64  `json:"forge_id,omitempty"`   // forge ID for multi-forge display
	ForgeName string `json:"forge_name,omitempty"` // forge hostname for multi-forge display
	ForgeIcon string `json:"forge_icon,omitempty"` // forge icon name/URL for multi-forge display
	ForgeType string `json:"forge_type,omitempty"` // forge type (github, gitlab, etc.) for icon fallback

} //	@name	RegistryWithOrg

RegistryWithOrg extends Registry with organization context for user views.

type Repo

type Repo struct {
	bun.BaseModel `bun:"table:repos"`

	ID      int64 `json:"id,omitempty"                    bun:"id,pk,autoincrement"`
	UserID  int64 `json:"-"                               bun:"user_id"`
	ForgeID int64 `json:"forge_id,omitempty"              bun:"forge_id,unique:forge,unique:forge_full_name"`
	// ForgeRemoteID is the unique identifier for the repository on the forge.
	ForgeRemoteID                ForgeRemoteID         `json:"forge_remote_id"                 bun:"forge_remote_id"`
	OrgID                        int64                 `json:"org_id"                          bun:"org_id"`
	Owner                        string                `json:"owner"                           bun:"owner,unique:forge"`
	Name                         string                `json:"name"                            bun:"name,unique:forge"`
	FullName                     string                `json:"full_name"                       bun:"full_name,unique:forge_full_name"`
	Avatar                       string                `json:"avatar_url,omitempty"            bun:"avatar,type:varchar(500)"`
	ForgeURL                     string                `json:"forge_url,omitempty"             bun:"forge_url,type:varchar(1000)"`
	Clone                        string                `json:"clone_url,omitempty"             bun:"clone,type:varchar(1000)"`
	CloneSSH                     string                `json:"clone_url_ssh"                   bun:"clone_ssh,type:varchar(1000)"`
	Branch                       string                `json:"default_branch,omitempty"        bun:"branch,type:varchar(500)"`
	PREnabled                    bool                  `json:"pr_enabled"                      bun:"pr_enabled,default:true"`
	Timeout                      int64                 `json:"timeout,omitempty"               bun:"timeout"`
	Visibility                   RepoVisibility        `json:"visibility"                      bun:"visibility,type:varchar(10)"`
	IsSCMPrivate                 bool                  `json:"private"                         bun:"private"`
	Trusted                      TrustedConfiguration  `json:"trusted"                         bun:"trusted,type:text"`
	RequireApproval              ApprovalMode          `json:"require_approval"                bun:"require_approval,type:varchar(50)"`
	IsActive                     bool                  `json:"active"                          bun:"active"`
	AllowPull                    bool                  `json:"allow_pr"                        bun:"allow_pr"`
	AllowDeploy                  bool                  `json:"allow_deploy"                    bun:"allow_deploy"`
	AllowManual                  bool                  `json:"allow_manual"                    bun:"allow_manual"`
	DeployTeam                   string                `json:"deploy_team"                     bun:"deploy_team,type:varchar(250)"`
	Config                       string                `json:"config_file"                     bun:"config_path,type:varchar(500)"`
	Hash                         string                `json:"-"                               bun:"hash,type:varchar(500)"`
	Perm                         *Perm                 `json:"-"                               bun:"-"`
	CancelPreviousPipelineEvents JSONSliceWebhookEvent `json:"cancel_previous_pipeline_events" bun:"cancel_previous_pipeline_events,type:text"`
	NetrcTrustedPlugins          JSONSliceString       `json:"netrc_trusted"                   bun:"netrc_trusted,type:text"`
	LogsPipelinesKeepMin         int64                 `json:"logs_keep_min,omitempty"         bun:"logs_keep_min"`
	LogsDurationKeep             string                `json:"logs_keep_duration"              bun:"logs_keep_duration,type:varchar(500)"`

} //	@name	Repo

Repo represents a repository.

func (*Repo) ResetVisibility

func (r *Repo) ResetVisibility()

func (Repo) TableName

func (Repo) TableName() string

TableName returns the database table name.

func (*Repo) Update

func (r *Repo) Update(from *Repo)

Update updates the repository with values from the given Repo.

type RepoLastPipeline

type RepoLastPipeline struct {
	Repo
	LastPipeline *Pipeline `json:"last_pipeline,omitempty"`

} //	@name	RepoLastPipeline

RepoLastPipeline represents a repository with last pipeline execution information.

type RepoMetric

type RepoMetric struct {
	RepoID         int64   `json:"repo_id"`
	RepoName       string  `json:"repo_name"`
	RepoFullName   string  `json:"repo_full_name"`
	PipelineCount  int64   `json:"pipeline_count"`
	AvgBuildTime   float64 `json:"avg_build_time"`   // in seconds
	TotalBuildTime float64 `json:"total_build_time"` // in seconds
}

RepoMetric represents metrics for a specific repository.

type RepoMetricData added in v6.2.0

type RepoMetricData struct {
	RepoID        int64
	RepoFullName  string
	PipelineCount int64
}

RepoMetricData holds aggregated pipeline data for a repo, with the display name carried straight from the denormalized pipeline rows so it survives repo deletion.

type RepoPatch

type RepoPatch struct {
	Config                       *string                    `json:"config_file,omitempty"`
	RequireApproval              *string                    `json:"require_approval,omitempty"`
	Timeout                      *int64                     `json:"timeout,omitempty"`
	Visibility                   *string                    `json:"visibility,omitempty"`
	AllowPull                    *bool                      `json:"allow_pr,omitempty"`
	AllowDeploy                  *bool                      `json:"allow_deploy,omitempty"`
	AllowManual                  *bool                      `json:"allow_manual,omitempty"`
	DeployTeam                   *string                    `json:"deploy_team,omitempty"`
	CancelPreviousPipelineEvents *[]WebhookEvent            `json:"cancel_previous_pipeline_events,omitempty"`
	LogsPipelinesKeepMin         *int64                     `json:"logs_keep_min,omitempty"`
	LogsDurationKeep             *string                    `json:"logs_keep_duration,omitempty"`
	NetrcTrusted                 *[]string                  `json:"netrc_trusted,omitempty"`
	Trusted                      *TrustedConfigurationPatch `json:"trusted,omitempty"`

} //	@name	RepoPatch

RepoPatch represents a repository patch object.

type RepoVisibility

type RepoVisibility string //	@name	RepoVisibility

RepoVisibility represent to what state a repo in woodpecker is visible to others.

const (
	VisibilityPublic   RepoVisibility = "public"
	VisibilityPrivate  RepoVisibility = "private"
	VisibilityInternal RepoVisibility = "internal"
)

type Role added in v6.11.0

type Role string

Role is an instance role a user holds besides admin.

const (
	RoleOperator       Role = "operator"
	RoleSecretsManager Role = "secrets-manager"
	RoleAuditor        Role = "auditor"
)

func AllRoles added in v6.11.0

func AllRoles() []Role

AllRoles returns every role in display order.

func ParseRoles added in v6.11.0

func ParseRoles(in []string) ([]Role, error)

ParseRoles validates role names, and returns them deduplicated and sorted.

func (Role) IsValid added in v6.11.0

func (r Role) IsValid() bool

IsValid reports whether r is a known role.

type Secret

type Secret struct {
	bun.BaseModel `bun:"table:secrets"`

	ID        int64                 `json:"id"              bun:"id,pk,autoincrement"`
	OrgID     int64                 `json:"org_id"          bun:"org_id,notnull,default:0,unique:s"`
	RepoID    int64                 `json:"repo_id"         bun:"repo_id,notnull,default:0,unique:s"`
	Name      string                `json:"name"            bun:"name,notnull,unique:s"`
	Value     string                `json:"value,omitempty" bun:"value,type:text"`
	Images    JSONSliceString       `json:"images"          bun:"images,type:text"`
	Events    JSONSliceWebhookEvent `json:"events"          bun:"events,type:text"`
	Source    string                `json:"source"          bun:"source,type:varchar(50),default:'internal'"`
	CreatedAt int64                 `json:"created_at"      bun:",nullzero"`
	UpdatedAt int64                 `json:"updated_at"      bun:",nullzero"`

} //	@name	Secret

Secret represents a secret variable, such as a password or token.

func (*Secret) BeforeAppendModel added in v6.11.0

func (s *Secret) BeforeAppendModel(_ context.Context, query bun.Query) error

func (*Secret) BeforeInsert

func (s *Secret) BeforeInsert()

BeforeInsert will sort events and set defaults before inserted into database.

func (*Secret) BeforeUpdate

func (s *Secret) BeforeUpdate()

BeforeUpdate normalizes PEM values before updating in the database.

func (*Secret) Copy

func (s *Secret) Copy() *Secret

Copy makes a copy of the secret without the value.

func (*Secret) CopyWithAbbreviatedValue

func (s *Secret) CopyWithAbbreviatedValue() *Secret

CopyWithAbbreviatedValue makes a copy of the secret with an abbreviated value. The abbreviated value shows the first 6 and last 6 characters for verification.

func (Secret) IsGlobal

func (s Secret) IsGlobal() bool

Global secret.

func (Secret) IsOrganization

func (s Secret) IsOrganization() bool

Organization secret.

func (Secret) IsRepository

func (s Secret) IsRepository() bool

Repository secret.

func (Secret) TableName

func (Secret) TableName() string

TableName returns the database table name.

func (*Secret) Validate

func (s *Secret) Validate() error

Validate validates the required fields and formats.

func (*Secret) WithOrg

func (s *Secret) WithOrg(orgName string, isPersonalOrg bool, forgeID int64, forgeName, forgeIcon, forgeType string) *SecretWithOrg

WithOrg creates a SecretWithOrg from a Secret with the given org name.

func (*Secret) WithRepo

func (s *Secret) WithRepo(repoName string, forgeID int64, forgeName, forgeIcon, forgeType string) *SecretWithOrg

WithRepo creates a SecretWithOrg from a Secret with the given repo name.

type SecretStore

type SecretStore interface {
	SecretFind(*Repo, string) (*Secret, error)
	SecretFindByID(int64) (*Secret, error)
	SecretList(*Repo, bool, *ListOptions) ([]*Secret, error)
	SecretCreate(*Secret) error
	SecretUpdate(*Secret) error
	SecretDelete(*Secret) error
	OrgSecretFind(int64, string) (*Secret, error)
	OrgSecretList(int64, *ListOptions) ([]*Secret, error)
	GlobalSecretFind(string) (*Secret, error)
	GlobalSecretList(*ListOptions) ([]*Secret, error)
	SecretListAll() ([]*Secret, error)
}

SecretStore persists secret information to storage.

type SecretTarget

type SecretTarget struct {
	bun.BaseModel `bun:"table:secret_targets"`

	ID        int64 `json:"id"         bun:"id,pk,autoincrement"`
	SecretID  int64 `json:"secret_id"  bun:"secret_id,notnull,unique:st"`
	OrgID     int64 `json:"org_id"     bun:"org_id,notnull,default:0,unique:st"`
	RepoID    int64 `json:"repo_id"    bun:"repo_id,notnull,default:0,unique:st"`
	CreatedAt int64 `json:"created_at" bun:",nullzero"`
}

SecretTarget represents a sharing assignment for a secret to an additional org or repo.

func (SecretTarget) TableName

func (SecretTarget) TableName() string

TableName returns the database table name.

type SecretTargetStore

type SecretTargetStore interface {
	SecretTargetCreate(target *SecretTarget) error
	SecretTargetDelete(target *SecretTarget) error
	SecretTargetList(secretID int64) ([]*SecretTarget, error)
	SecretTargetFind(secretID int64, orgID int64, repoID int64) (*SecretTarget, error)
	SecretTargetDeleteBySecretID(secretID int64) error
	SecretTargetCheckConflict(secretID int64, secretName string, orgID int64, repoID int64) error
}

SecretTargetStore persists secret target information to storage.

type SecretWithOrg

type SecretWithOrg struct {
	Secret
	OrgName        string `json:"org_name"`
	RepoName       string `json:"repo_name,omitempty"`
	ScopeType      string `json:"scope_type"`           // "user", "org", "repo", or "global"
	ForgeID        int64  `json:"forge_id,omitempty"`   // forge ID for multi-forge display
	ForgeName      string `json:"forge_name,omitempty"` // forge hostname for multi-forge display
	ForgeIcon      string `json:"forge_icon,omitempty"` // forge icon name/URL for multi-forge display
	ForgeType      string `json:"forge_type,omitempty"` // forge type (github, gitlab, etc.) for icon fallback
	IsShared       bool   `json:"is_shared,omitempty"`
	FirstOwnerName string `json:"first_owner_name,omitempty"`

} //	@name	SecretWithOrg

SecretWithOrg extends Secret with organization and repository context for user views.

type ServerConfig

type ServerConfig struct {
	bun.BaseModel `bun:"table:server_configs"`

	Key   string `json:"key"   bun:"key,pk"`
	Value string `json:"value" bun:"value"`
}

ServerConfig represents a key-value pair for storing server configurations.

func (ServerConfig) TableName

func (ServerConfig) TableName() string

TableName returns the database table name.

type StatusValue

type StatusValue string //	@name	StatusValue

StatusValue represent pipeline states woodpecker know.

const (
	StatusSkipped   StatusValue = "skipped"   // skipped as another step failed
	StatusPending   StatusValue = "pending"   // pending to be executed
	StatusPreparing StatusValue = "preparing" // backend is preparing the step
	StatusRunning   StatusValue = "running"   // currently running
	StatusSuccess   StatusValue = "success"   // successfully finished
	StatusFailure   StatusValue = "failure"   // failed to finish (exit code != 0)
	StatusKilled    StatusValue = "killed"    // killed by user
	StatusError     StatusValue = "error"     // error with the config / while parsing / some other system problem
	StatusBlocked   StatusValue = "blocked"   // waiting for approval
	StatusDeclined  StatusValue = "declined"  // blocked and declined
	StatusCreated   StatusValue = "created"   // created / internal use only
)

func PipelineStatus

func PipelineStatus(workflows []*Workflow) StatusValue

PipelineStatus determines pipeline status based on the corresponding workflow list. Only the latest attempt of each workflow is considered.

Precedence (highest wins):

  1. StatusKilled — any workflow killed by the user.
  2. StatusDeclined — any workflow declined or expired at an approval gate.
  3. StatusFailure / StatusError — any workflow failed (terminal outcome).
  4. StatusBlocked — any workflow still waiting for an approval gate. This is more actionable than "running" and matches what the pipeline-level approval gate uses, so the UI shows the same icon and affordances.
  5. StatusRunning — any workflow still pending or running.
  6. StatusSuccess — every workflow reached a non-failing terminal state.

Failure overrides blocked / running because it is terminal: the pipeline is doomed regardless of any other gates or pending work. Blocked overrides running because a blocked gate requires human action, which is more useful to surface to the user than a generic "wait".

func WorkflowStatus

func WorkflowStatus(steps []*Step) StatusValue

WorkflowStatus determine workflow status based on corresponding step list.

func (StatusValue) Validate

func (s StatusValue) Validate() error

type Step

type Step struct {
	bun.BaseModel `bun:"table:steps"`

	ID             int64           `json:"id"                   bun:"id,pk,autoincrement"`
	UUID           string          `json:"uuid"                 bun:"uuid"`
	PipelineID     int64           `json:"pipeline_id"          bun:"pipeline_id,unique:s"`
	PID            int             `json:"pid"                  bun:"pid,unique:s"`
	PPID           int             `json:"ppid"                 bun:"ppid"`
	Name           string          `json:"name"                 bun:"name"`
	State          StatusValue     `json:"state"                bun:"state"`
	Error          string          `json:"error,omitempty"      bun:"error,type:text"`
	Failure        string          `json:"failure,omitempty"    bun:"failure"`
	ExitCode       int             `json:"exit_code"            bun:"exit_code"`
	Started        int64           `json:"started,omitempty"    bun:"started"`
	Finished       int64           `json:"finished,omitempty"   bun:"finished"`
	Type           StepType        `json:"type,omitempty"        bun:"type"`
	DependsOn      JSONSliceString `json:"depends_on,omitempty"  bun:"depends_on,type:text"`
	OriginalStepID int64           `json:"original_step_id"      bun:"original_step_id,default:0"`
	Attempt        int             `json:"attempt"               bun:"attempt,default:1"`

} //	@name	Step

Step represents a process in the pipeline.

func (*Step) Failing

func (p *Step) Failing() bool

Failing returns true if the process state is failed, killed or error.

func (*Step) Running

func (p *Step) Running() bool

Running returns true if the process state is pending, preparing, or running.

func (Step) TableName

func (Step) TableName() string

TableName returns the database table name.

type StepType

type StepType string //	@name	StepType

StepType identifies the type of step.

const (
	StepTypeClone    StepType = "clone"
	StepTypeService  StepType = "service"
	StepTypePlugin   StepType = "plugin"
	StepTypeCommands StepType = "commands"
	StepTypeCache    StepType = "cache"
)

type Task

type Task struct {
	bun.BaseModel `bun:"table:tasks"`

	ID               string                   `json:"id"           bun:"id,pk"`
	PID              int                      `json:"pid"          bun:"pid"`
	Name             string                   `json:"name"         bun:"name"`
	Data             []byte                   `json:"-"            bun:"data"`
	Labels           JSONMapStringString      `json:"labels"       bun:"labels,type:text"`
	Dependencies     JSONSliceString          `json:"dependencies" bun:"dependencies,type:text"`
	RunOn            JSONSliceString          `json:"run_on"       bun:"run_on,type:text"`
	RequiresApproval bool                     `json:"requires_approval,omitempty" bun:"requires_approval,scanonly"`
	ApprovalState    ApprovalState            `json:"approval_state,omitempty"    bun:"approval_state,scanonly"`
	DepStatus        JSONMapStringStatusValue `json:"dep_status"   bun:"dependencies_status,type:text"`
	AgentID          int64                    `json:"agent_id"     bun:"agent_id"`
	PipelineID       int64                    `json:"pipeline_id"  bun:"pipeline_id"`
	RepoID           int64                    `json:"repo_id"      bun:"repo_id"`
	Canceled         int64                    `json:"canceled"    bun:"canceled"`
	CancelledAt      int64                    `json:"canceled_at" bun:"canceled_at"`

} //	@name	Task

Task defines scheduled pipeline Task.

func (*Task) ApplyLabelsFromRepo

func (t *Task) ApplyLabelsFromRepo(r *Repo) error

func (*Task) ShouldRun

func (t *Task) ShouldRun() bool

ShouldRun tells if a task should be run or skipped, based on dependencies.

func (*Task) String

func (t *Task) String() string

func (Task) TableName

func (Task) TableName() string

TableName returns the database table name.

type Team

type Team struct {
	// Login is the username for this team.
	Login string `json:"login"`

	// the avatar url for this team.
	Avatar string `json:"avatar_url"`
}

Team represents a team or organization in the forge.

type TeamMembership

type TeamMembership struct {
	// Org is the org/owner login this team belongs to.
	// On GitHub: the org slug. On GitLab: the root group path.
	Org string `json:"org"`

	// Team is the team slug or — on GitLab — the path of the subgroup relative
	// to Org (e.g. "sub/sub2/team" for a 3-deep subgroup under Org).
	Team string `json:"team"`

} //	@name	TeamMembership

TeamMembership represents the caller's membership in a team within an organization on a forge. Returned by Forge.TeamMemberships.

func (TeamMembership) Path

func (m TeamMembership) Path() string

Path returns the canonical "org/team" form used for matching against YAML.

type TrustedConfiguration

type TrustedConfiguration struct {
	Network  bool `json:"network"`
	Volumes  bool `json:"volumes"`
	Security bool `json:"security"`
}

func (*TrustedConfiguration) Scan

func (t *TrustedConfiguration) Scan(src any) error

func (TrustedConfiguration) Value

func (t TrustedConfiguration) Value() (driver.Value, error)

type TrustedConfigurationPatch

type TrustedConfigurationPatch struct {
	Network  *bool `json:"network,omitempty"`
	Volumes  *bool `json:"volumes,omitempty"`
	Security *bool `json:"security,omitempty"`
}

type User

type User struct {
	bun.BaseModel `bun:"table:users"`

	// the id for this user.
	//
	// required: true
	ID int64 `json:"id" bun:"id,pk,autoincrement"`

	// ForgeID is the forge this user originally registered with.
	//
	// Deprecated: Use PrimaryForgeID and UserForge table for multi-forge support.
	ForgeID int64 `json:"forge_id,omitempty" bun:"forge_id"`

	// ForgeRemoteID is the user's ID on their original forge.
	//
	// Deprecated: Use UserForge table for multi-forge support.
	ForgeRemoteID ForgeRemoteID `json:"-" bun:"forge_remote_id"`

	// PrimaryForgeID references the user_forges.id of the user's primary forge connection.
	// The primary forge is the first forge the user registered with and cannot be unlinked.
	PrimaryForgeID int64 `json:"primary_forge_id,omitempty" bun:"primary_forge_id"`

	// Login is the username for this user.
	//
	// required: true
	Login string `json:"login" bun:"login,unique"`

	// AccessToken is the oauth2 access token.
	//
	// Deprecated: Use UserForge table for multi-forge support.
	AccessToken string `json:"-" bun:"access_token,type:text"`

	// RefreshToken is the oauth2 refresh token.
	//
	// Deprecated: Use UserForge table for multi-forge support.
	RefreshToken string `json:"-" bun:"refresh_token,type:text"`

	// Expiry is the AccessToken expiration timestamp (unix seconds).
	//
	// Deprecated: Use UserForge table for multi-forge support.
	Expiry int64 `json:"-" bun:"expiry"`

	// Email is the email address for this user.
	//
	// required: true
	Email string `json:"email" bun:"email,type:varchar(500)"`

	// the avatar url for this user.
	Avatar string `json:"avatar_url" bun:"avatar,type:varchar(500)"`

	// Admin indicates the user is a system administrator.
	//
	// NOTE: If the username is part of the WOODPECKER_ADMIN
	// environment variable, this value will be set to true on login.
	Admin bool `json:"admin,omitempty" bun:"admin"`

	// Roles are the instance roles of the user besides admin, see role.go.
	Roles JSONSliceString `json:"roles" bun:"roles,type:text"`

	// Hash is a unique token used to sign tokens.
	Hash string `json:"-" bun:"hash,unique,type:varchar(500)"`

	// OrgID is the of the user as model.Org.
	OrgID int64 `json:"org_id" bun:"org_id"`

	// Description is a short bio or description for this user.
	Description string `json:"description,omitempty" bun:"description,type:text"`

	// Timezone is the user's timezone (e.g., "America/New_York", "Europe/Berlin").
	Timezone string `json:"timezone,omitempty" bun:"timezone,type:varchar(100)"`

} //	@name	User

User represents a registered user.

func (*User) AdminScopes added in v6.11.0

func (u *User) AdminScopes() []AccessTokenScope

AdminScopes returns the admin scopes the user may put on a token: admin:read with any admin permission, and admin:write with any permission that changes state.

func (*User) Can added in v6.11.0

func (u *User) Can(p Permission) bool

Can reports whether the user holds permission p.

func (*User) HasAnyReadPermission added in v6.11.0

func (u *User) HasAnyReadPermission() bool

HasAnyReadPermission reports whether the user may read any admin area.

func (*User) HasAnyWritePermission added in v6.11.0

func (u *User) HasAnyWritePermission() bool

HasAnyWritePermission reports whether the user may change any admin area.

func (*User) HasRole added in v6.11.0

func (u *User) HasRole(r Role) bool

HasRole reports whether the user holds role r. Unknown stored names never match.

func (User) MarshalJSON added in v6.11.0

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON adds the effective permissions, and always emits roles as an array.

func (*User) Permissions added in v6.11.0

func (u *User) Permissions() []Permission

Permissions returns the user's effective permissions, sorted.

func (User) TableName

func (User) TableName() string

TableName returns the database table name.

func (*User) Validate

func (u *User) Validate() error

Validate validates the required fields and formats.

type UserForge

type UserForge struct {
	bun.BaseModel `bun:"table:user_forges"`

	// ID is the unique identifier for this user-forge connection.
	ID int64 `json:"id" bun:"id,pk,autoincrement"`

	// UserID references the user who owns this forge connection.
	UserID int64 `json:"user_id" bun:"user_id,notnull"`

	// ForgeID references the forge this connection is for.
	ForgeID int64 `json:"forge_id" bun:"forge_id,notnull,unique:forge_user"`

	// ForgeRemoteID is the user's unique identifier on the forge (e.g., GitHub user ID).
	// Combined with ForgeID, this must be unique across all users.
	ForgeRemoteID ForgeRemoteID `json:"-" bun:"forge_remote_id,unique:forge_user"`

	// IsPrimary indicates if this is the user's primary forge (first registered).
	// Each user has exactly one primary forge which cannot be unlinked.
	IsPrimary bool `json:"is_primary" bun:"is_primary,notnull,default:false"`

	// OAuth tokens for this forge connection
	AccessToken  string `json:"-" bun:"access_token,type:text"`
	RefreshToken string `json:"-" bun:"refresh_token,type:text"`
	Expiry       int64  `json:"-" bun:"expiry"`

	// ForgeLogin is the username on this forge (may differ from User.Login).
	ForgeLogin string `json:"forge_login" bun:"forge_login,type:varchar(250)"`

	// ForgeEmail is the email address on this forge.
	ForgeEmail string `json:"forge_email,omitempty" bun:"forge_email,type:varchar(500)"`

	// ForgeAvatar is the avatar URL on this forge.
	ForgeAvatar string `json:"forge_avatar,omitempty" bun:"forge_avatar,type:varchar(500)"`

	// LinkedAt is the unix timestamp when this forge was linked.
	LinkedAt int64 `json:"linked_at" bun:"linked_at,notnull"`

	// LastUsed is the unix timestamp when this forge was last used for an operation.
	LastUsed int64 `json:"last_used,omitempty" bun:"last_used"`

} //	@name	UserForge

UserForge represents a user's OAuth credentials for a specific forge. A user can have multiple forge connections (e.g., GitHub + GitLab), allowing them to manage repositories from different forges under one account.

func (UserForge) TableName

func (UserForge) TableName() string

TableName returns the database table name.

type UserIdentity added in v6.11.0

type UserIdentity struct {
	bun.BaseModel `bun:"table:user_identities"`

	ID int64 `json:"id" bun:"id,pk,autoincrement"`

	// UserID references the Crow user this identity belongs to.
	UserID int64 `json:"-" bun:"user_id,notnull"`

	// Provider names the identity provider kind, e.g. "oidc".
	Provider string `json:"provider" bun:"provider,type:varchar(50),notnull,unique:provider_subject"`

	// Issuer is the identity provider's issuer URL. A subject is only unique
	// within its issuer, so identities are keyed by provider, issuer and subject.
	Issuer string `json:"issuer" bun:"issuer,type:varchar(255),notnull,default:'',unique:provider_subject"`

	// Subject is the stable user identifier at the provider (the OIDC "sub" claim).
	Subject string `json:"subject" bun:"subject,type:varchar(255),notnull,unique:provider_subject"`

	// Email, Username and Groups are the values last seen at sign-in.
	Email    string          `json:"email,omitempty" bun:"email,type:varchar(500)"`
	Username string          `json:"username,omitempty" bun:"username,type:varchar(250)"`
	Groups   JSONSliceString `json:"groups" bun:"idp_groups,type:text"`

	// LinkedAt is the unix timestamp when this identity was linked.
	LinkedAt int64 `json:"linked_at" bun:"linked_at,notnull"`

	// LastLogin is the unix timestamp of the last sign-in through this identity.
	LastLogin int64 `json:"last_login,omitempty" bun:"last_login"`

} //	@name	UserIdentity

UserIdentity links a Crow user to an account at an external identity provider (for example an OpenID Connect issuer). Unlike UserForge it carries no tokens: it only proves who the user is at sign-in.

type VaultConfig

type VaultConfig struct {
	// Connection
	Address   string `json:"address"`             // Vault server URL (e.g., https://vault.example.com)
	Namespace string `json:"namespace,omitempty"` // Vault Enterprise namespace

	// AppRole Authentication
	RoleID   string `json:"role_id"`   // AppRole Role ID
	SecretID string `json:"secret_id"` // AppRole Secret ID (encrypted in storage)

	// Paths
	MountPath string `json:"mount_path"` // Secrets engine mount path (default: "secret")
	AuthPath  string `json:"auth_path"`  // Auth method path (default: "auth/approle")

	// TimeoutSeconds is the HTTP request timeout for Vault calls (auth + reads).
	// Defaults to DefaultVaultTimeoutSeconds when unset or <= 0.
	TimeoutSeconds int `json:"timeout_seconds,omitempty"`

	// TLS Configuration
	TLSConfig *VaultTLSConfig `json:"tls_config,omitempty"`
}

VaultConfig holds HashiCorp Vault/OpenBao specific configuration.

func (*VaultConfig) Redacted

func (c *VaultConfig) Redacted() *VaultConfig

Redacted returns a copy with sensitive fields redacted.

func (*VaultConfig) RequestTimeout

func (c *VaultConfig) RequestTimeout() time.Duration

RequestTimeout returns the configured HTTP timeout for Vault requests.

func (*VaultConfig) Validate

func (c *VaultConfig) Validate() error

Validate validates the Vault configuration.

func (*VaultConfig) WithDefaults

func (c *VaultConfig) WithDefaults() *VaultConfig

WithDefaults returns a copy with default values applied.

type VaultTLSConfig

type VaultTLSConfig struct {
	CACert        string `json:"ca_cert,omitempty"`         // CA certificate (PEM)
	ClientCert    string `json:"client_cert,omitempty"`     // Client certificate (PEM)
	ClientKey     string `json:"client_key,omitempty"`      // Client private key (PEM)
	TLSServerName string `json:"tls_server_name,omitempty"` // Server name for SNI
	Insecure      bool   `json:"insecure,omitempty"`        // Skip TLS verification (for dev only)
}

VaultTLSConfig holds TLS configuration for Vault connections.

type WebhookEvent

type WebhookEvent string //	@name	WebhookEvent
const (
	EventPush       WebhookEvent = "push"
	EventPull       WebhookEvent = "pull_request"
	EventPullClosed WebhookEvent = "pull_request_closed"
	EventPullMerged WebhookEvent = "pull_request_merged"
	EventPullEdited WebhookEvent = "pull_request_edited"
	EventTag        WebhookEvent = "tag"
	EventRelease    WebhookEvent = "release"
	EventDeploy     WebhookEvent = "deployment"
	EventCron       WebhookEvent = "cron"
	EventManual     WebhookEvent = "manual"
)

func (WebhookEvent) Validate

func (s WebhookEvent) Validate() error

type WebhookEventList

type WebhookEventList []WebhookEvent

func (WebhookEventList) Len

func (wel WebhookEventList) Len() int

func (WebhookEventList) Less

func (wel WebhookEventList) Less(i, j int) bool

func (WebhookEventList) Swap

func (wel WebhookEventList) Swap(i, j int)

type Workflow

type Workflow struct {
	bun.BaseModel `bun:"table:workflows"`

	ID                          int64               `json:"id"                            bun:"id,pk,autoincrement"`
	PipelineID                  int64               `json:"pipeline_id"                   bun:"pipeline_id,unique:s"`
	PID                         int                 `json:"pid"                           bun:"pid,unique:s"`
	Name                        string              `json:"name"                          bun:"name"`
	PipelineName                string              `json:"pipeline_name"                 bun:"pipeline_name"`
	State                       StatusValue         `json:"state"                         bun:"state"`
	Error                       string              `json:"error,omitempty"               bun:"error,type:text"`
	Started                     int64               `json:"started,omitempty"             bun:"started"`
	Finished                    int64               `json:"finished,omitempty"            bun:"finished"`
	AgentID                     int64               `json:"agent_id,omitempty"            bun:"agent_id"`
	AgentPersistentID           string              `json:"agent_persistent_id,omitempty" bun:"agent_persistent_id,type:varchar(64)"`
	AgentName                   string              `json:"agent_name,omitempty"          bun:"agent_name,type:varchar(255)"`
	Platform                    string              `json:"platform,omitempty"            bun:"platform"`
	Environ                     JSONMapStringString `json:"environ,omitempty"             bun:"environ,type:text"`
	DependsOn                   JSONSliceString     `json:"depends_on,omitempty"          bun:"depends_on,type:text"`
	RequiresApproval            bool                `json:"requires_approval,omitempty"        bun:"requires_approval,default:false"`
	ApprovalUsers               JSONSliceString     `json:"approval_users,omitempty"           bun:"approval_users,type:text"`
	ApprovalTeams               JSONSliceString     `json:"approval_teams,omitempty"           bun:"approval_teams,type:text"`
	ApprovalState               ApprovalState       `json:"approval_state,omitempty"           bun:"approval_state"`
	ApprovalDeadline            int64               `json:"approval_deadline,omitempty"        bun:"approval_deadline,default:0"`
	ApprovalTimeoutSeconds      int64               `json:"approval_timeout_seconds,omitempty" bun:"approval_timeout_seconds,default:0"`
	AxisID                      int                 `json:"-"                             bun:"axis_id"`
	OriginalWorkflowID          int64               `json:"original_workflow_id"           bun:"original_workflow_id,default:0"`
	Attempt                     int                 `json:"attempt"                       bun:"attempt,default:1"`
	Children                    []*Step             `json:"children,omitempty"                     bun:"-"`
	AutoscalerProvisioning      bool                `json:"autoscaler_provisioning,omitempty"       bun:"-"`
	AutoscalerProvisioningStale bool                `json:"autoscaler_provisioning_stale,omitempty" bun:"-"`
	// AutoscalerProvisioningSince is when the autoscaler started waiting for
	// agents, and AutoscalerProvisionTimeout how long, in seconds, it expects
	// one to take to connect.
	AutoscalerProvisioningSince int64 `json:"autoscaler_provisioning_since,omitempty" bun:"-"`
	AutoscalerProvisionTimeout  int64 `json:"autoscaler_provision_timeout,omitempty"  bun:"-"`
	// ProvisioningAgents are the agents the autoscaler is starting, with the
	// phases their hosts reported.
	ProvisioningAgents []*ProvisioningAgent `json:"provisioning_agents,omitempty" bun:"-"`
}

Workflow represents a workflow in the pipeline.

func LatestAttempts

func LatestAttempts(workflows []*Workflow) []*Workflow

LatestAttempts returns only the latest attempt of each workflow, grouping by OriginalWorkflowID (or by the workflow's own ID if it is the original).

func (*Workflow) Failing

func (p *Workflow) Failing() bool

Failing returns true if the process state is failed, killed or error.

func (*Workflow) Running

func (p *Workflow) Running() bool

Running returns true if the process state is pending or running.

func (Workflow) TableName

func (Workflow) TableName() string

TableName returns the database table name.

type WorkflowApprovalEvent

type WorkflowApprovalEvent struct {
	bun.BaseModel `bun:"table:workflow_approval_events"`

	ID         int64          `json:"id"          bun:"id,pk,autoincrement"`
	WorkflowID int64          `json:"workflow_id" bun:"workflow_id,notnull"`
	UserID     int64          `json:"user_id"     bun:"user_id"` // 0 if system (timeout)
	Action     ApprovalAction `json:"action"      bun:"action,notnull"`
	Reason     string         `json:"reason"      bun:"reason,type:text"`
	CreatedAt  int64          `json:"created_at"  bun:"created_at,notnull"`

} //	@name	WorkflowApprovalEvent

WorkflowApprovalEvent is an append-only audit row recording a single decision (or auto-expiry) against a workflow approval gate.

func (WorkflowApprovalEvent) TableName

func (WorkflowApprovalEvent) TableName() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址