config

package
v0.57.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (
	ArtifactContentAll      = "all"
	ArtifactContentMetadata = "metadata"
	ArtifactContentNone     = "none"
)

Run artifact content levels (ADR 0161). A level limits what the run artifact publishes: everything in output/ (all), only the run-level metadata files (metadata), or no artifact at all (none).

View Source
const (
	// DefaultUpstreamRepo is the canonical fullsend repository for layered workflow calls.
	DefaultUpstreamRepo = "fullsend-ai/fullsend"
	// DefaultAgentsRepo is the canonical repository for upstream agent resources.
	DefaultAgentsRepo = "fullsend-ai/agents"
	// DefaultUpstreamRef is the default ref for layered upstream workflow calls.
	DefaultUpstreamRef = "main"
	// DefaultGHRunner is the default GitHub Actions runner image for scaffold workflows.
	DefaultGHRunner = "ubuntu-24.04"
	// DefaultSandboxImage and DefaultCodeImage are the sandbox images
	// `fullsend agent new` writes into a generated harness. They track the
	// fleet's pins in fullsend-ai/agents (harness/triage.yaml and
	// harness/code.yaml). Nothing updates them automatically: repin them by
	// hand when a release repins the fleet. `agent new --image` overrides
	// them.
	DefaultSandboxImage = "ghcr.io/fullsend-ai/fullsend-sandbox@sha256:bcf8cd84a37623d761d38f2a6f51d20283f8798b7d3eeb9c509a2503c074bd55"
	DefaultCodeImage    = "ghcr.io/fullsend-ai/fullsend-code@sha256:3055d4f52136a7c89fb8aa1976b468a5f9dd929c6be55fd6cd958e222c6e18ca"
)
View Source
const (
	// AuthProviderOwnersFile consults the repo-root Prow OWNERS file for
	// GitHub events.
	AuthProviderOwnersFile = "owners_file"
	// AuthProviderJira configures actor authorization for Jira-sourced
	// events (jira-poll input driver).
	AuthProviderJira = "jira"
)

Authorization provider names accepted under authorization:.

View Source
const (
	// JiraLabelsEditors authorizes a Jira label-added event by Jira's own
	// Edit Issues permission: whoever could add the label may trigger.
	// This is the default when labels: is omitted.
	JiraLabelsEditors = "jira_editors"
	// JiraLabelsAllowlist checks the label author against the jira
	// provider's write and triage lists, like a slash command.
	JiraLabelsAllowlist = "allowlist"
	// JiraLabelsProjectRoles resolves the label author's role from the
	// Jira project role roster (needs the Administer Projects permission).
	JiraLabelsProjectRoles = "project_roles"
)

Values of the jira authorization provider's labels: field, which picks how a Jira label-added event is authorized.

View Source
const (
	// DefaultPerRepoMintURL is the hosted public mint used when no
	// mint_url is configured in config.yaml or config.base.yaml.
	DefaultPerRepoMintURL = "https://mint.fullsend.sh"

	// DefaultPerRepoInferenceProvider is the default inference backend.
	DefaultPerRepoInferenceProvider = "vertex"

	// DefaultPerRepoInferenceRegion is the default GCP region for
	// inference requests.
	DefaultPerRepoInferenceRegion = "global"
)

Operational code defaults for per-repo configs. These are the terminal values in the overlay → base → code defaults chain (ADR 0069 Decision 2). Callers that need the canonical default value without constructing a full config can reference these constants directly.

View Source
const (
	GatewayAPIOpenAIResponses   = "openai-responses"
	GatewayAPIAnthropicMessages = "anthropic-messages"
	GatewayAPIOpenAICompletions = "openai-completions"
)

Inference gateway APIs a model may speak (ADR 0137). They match the pi-inference-gateway extension's per-model "api" values.

View Source
const (
	// GatewayAuthOIDC presents the job's forge OIDC assertion for the
	// block's audience (ADR 0137). It is the default and the recommended
	// mode: the forge stores no reusable key.
	GatewayAuthOIDC = "oidc"
	// GatewayAuthAPIKey presents a gateway API key the runner reads from
	// FULLSEND_INFERENCE_GATEWAY_API_KEY (a forge secret or the local
	// environment). It is supported for gateways that cannot trust forge
	// OIDC, but it relies on a long-lived secret: use it with caution and
	// prefer oidc when the gateway supports it.
	GatewayAuthAPIKey = "api-key"
)

Inference gateway credential modes (inference.gateway.auth). There is no implicit precedence and no fallback between them: the block names one.

View Source
const (
	// GatewayMessagesAuthHeaderAuthorization sends the credential as
	// Authorization: Bearer, the header agentgateway reads by default
	// (ADR 0137). It is the default.
	GatewayMessagesAuthHeaderAuthorization = "authorization"
	// GatewayMessagesAuthHeaderXAPIKey sends the credential as x-api-key,
	// the header Anthropic documents for API keys on the Messages API. It
	// is valid only with GatewayAuthAPIKey.
	GatewayMessagesAuthHeaderXAPIKey = "x-api-key"
)

Inference gateway credential headers for Messages-dialect requests (inference.gateway.messages_auth_header, ADR 0142). The other dialects and codex always send Authorization: Bearer.

View Source
const (
	OverlayConfigFile = "config.yaml"
	BaseConfigFile    = "config.base.yaml"
)

Layer file names of a per-repo config directory (ADR 0069).

View Source
const (
	TrackingProviderGitHub = "github"
	TrackingProviderGitLab = "gitlab"
	TrackingProviderJira   = "jira"
)

Issue-tracker provider names accepted as keys under tracker:.

View Source
const (
	// ManagedConfigSchemaLegacy is the per-repo configuration schema that
	// predates the provider-discriminated tracker mapping (#9074): issue
	// tracking is the scalar tracker key plus create_issues.allow_targets.
	// A ref that declares no schema is treated as legacy unless it contains
	// the commit that introduced the tracker mapping.
	ManagedConfigSchemaLegacy = 1
	// ManagedConfigSchemaTrackerMapping is the schema with the tracker
	// mapping (#9082) that predates the harness: block of an agents: entry.
	ManagedConfigSchemaTrackerMapping = 2
	// ManagedConfigSchemaVersion is the schema this binary reads and
	// renders: an agents: entry may carry a harness: block (ADR 0162). It
	// must equal the value declared in ManagedConfigSchemaDeclarationPath.
	ManagedConfigSchemaVersion = 3
)

Managed configuration schema versions (#9292). A repository's .fullsend/config.yaml is read by the Fullsend runtime at the repository's effective fullsend_ref, which may be older or newer than the binary that renders the file, so `fullsend repos` renders and checks the file in the schema that ref declares.

View Source
const (
	ProgressVerbosityFull  = "full"
	ProgressVerbosityTools = "tools"
	ProgressVerbosityQuiet = "quiet"
)

Live progress log levels (ADR 0163). A level limits what `fullsend run` prints to the job log while an agent runs: everything (full), everything but reasoning and reply text (tools), or only lines fullsend writes from its own fields (quiet).

View Source
const (
	// SecretConnectionKindVault selects HashiCorp Vault KV v2 through the
	// job's workload identity.
	SecretConnectionKindVault = "vault"
	// NativeSecretConnection is the built-in connection name that selects
	// the forge-native source. It cannot be declared under connections.
	NativeSecretConnection = "native"
)

Secret connection kinds and the reserved native connection (ADR 0155).

View Source
const DefaultJiraAPIURL = "https://api.atlassian.com"

DefaultJiraAPIURL is the Jira API gateway URL used when tracker.jira.api_url is unset.

View Source
const DefaultJiraPollQuery = "statusCategory != Done ORDER BY updated DESC"

DefaultJiraPollQuery is the JQL predicate the Jira poller uses when tracker.jira.poll.query is unset. It is always scoped to the configured project (see JiraTrackingConfig.PollJQL).

View Source
const GatewayAPIBasePath = "/v1"

GatewayAPIBasePath is the model API base path the runner adds under the gateway URL: the runtimes call <url>/v1/..., and the egress profile binds the credential to <prefix>/v1/** only.

View Source
const ManagedConfigSchemaDeclarationPath = "internal/config/managed-config-schema"

ManagedConfigSchemaDeclarationPath is the path, in the fullsend-ai/fullsend repository, of the file that declares the per-repo configuration schema version of the source tree it is part of. `fullsend repos` reads it at a repository's pinned fullsend_ref to select the schema to render.

View Source
const MaxGatewayModelIDLength = 256

MaxGatewayModelIDLength is the longest model id the pi-inference-gateway extension accepts (v0.1.1 src/config.ts MAX_MODEL_ID_LENGTH), counted in UTF-16 code units as JavaScript counts string length.

View Source
const TraceSigningKeySecret = "FULLSEND_TRACE_SIGNING_KEY"

TraceSigningKeySecret is the only signing-key reference v1 accepts in trace_context.signing_key.secret.

Variables

This section is empty.

Functions

func CheckManagedConfigSchemaCompat added in v0.56.0

func CheckManagedConfigSchemaCompat(data []byte, version int) error

CheckManagedConfigSchemaCompat reports whether data, an installed per-repo configuration document, uses only shapes schema version reads: the legacy schema rejects the tracker mapping, later schemas reject the scalar tracker key and the removed create_issues block, and schemas before the current one do not read an agents: entry's harness: block. Blank or unparseable content is not judged here; the regular parser reports it.

func DefaultAgentRoles

func DefaultAgentRoles() []string

DefaultAgentRoles returns the standard set of agent roles installed when no custom roles are specified. The fix stage reuses the coder app (role: coder) so it does not need a separate app or PEM.

func DefaultAllowedRemoteResources added in v0.24.0

func DefaultAllowedRemoteResources() []string

DefaultAllowedRemoteResources returns the standard allowlist prefixes for base composition and agent registration URLs.

The raw.githubusercontent.com prefixes are always included. When GITHUB_SERVER_URL names a GitHub host other than github.com (for example GitHub Enterprise Server), the raw-content prefixes for the same repositories on that host (https://<host>/<owner>/<repo>/raw/) are appended, so their copies on the configured host are admitted too.

func DefaultIssueCreationRepos added in v0.49.0

func DefaultIssueCreationRepos() []string

DefaultIssueCreationRepos returns the cross-repository issue destinations granted by a fresh GitHub installation without a preset or explicit tracker setting. The source repository is implicitly allowed by the post-scripts. Each call returns its own slice so callers can customize it independently.

func EffectiveAllowedResources added in v0.56.1

func EffectiveAllowedResources(cfg ConfigReader) []string

EffectiveAllowedResources returns the config-level allowlist the command families that run or edit agents resolve — run/lint/lock, harness dispatch, dispatch --route, the Jira poll and the agent-editing commands (agent set/add/update/remove): the layered chain as-is (an omitted key falls through to the parent, an explicit [] denies all remote resources, a non-empty list unions with the parent's), then fullsend's default prefixes ensured on top of a non-empty result.

func EffectiveYAML added in v0.47.0

func EffectiveYAML(r PerRepoConfigReader) ([]byte, error)

EffectiveYAML renders the effective values of a layered per-repo configuration (overlay → base → code defaults) as a YAML mapping, one top-level key per setting, resolved through the whole parent chain. It is a read-only view for operator guidance (for example the effective difference shown when adopting an existing configuration file); it is not a loadable configuration file.

The rendered allowed_remote_resources is the accessor-level list; command loaders additionally resolve EffectiveAllowedResources, which ensures fullsend's default prefixes on top of a non-empty result, so the rendered list may omit the default prefixes a command adds.

func EnsureDefaultAllowedRemoteResources added in v0.31.0

func EnsureDefaultAllowedRemoteResources(existing []string) []string

EnsureDefaultAllowedRemoteResources returns a new slice with default allowed-remote-resources prefixes merged into the provided list. Nil input (field omitted from YAML) returns defaults alone. An explicit empty slice (allowed_remote_resources: []) is returned unchanged to preserve deny-all semantics. Non-empty input gets any missing defaults appended (preserving the caller's original ordering).

func FormatSafetyRelaxations added in v0.44.0

func FormatSafetyRelaxations(rs []SafetyRelaxation) string

FormatSafetyRelaxations joins relaxations for error and status output.

func FormatTracking added in v0.55.0

func FormatTracking(t *TrackingConfig) string

FormatTracking renders t in the compact form used in migration notes, for example "tracker.github.allowed_targets: orgs=[a] repos=unset".

func GatewayPathPrefix added in v0.47.1

func GatewayPathPrefix(p string) (string, error)

GatewayPathPrefix checks the escaped path of a gateway URL and returns its prefix: "" for an empty path or "/", otherwise the path without a trailing slash. The prefix must be a clean absolute path: no empty (doubled-slash), "." or ".." segment, no percent-encoding (so no encoded "/"), only RFC 3986 unreserved characters in each segment, and no trailing /v1, which the runner adds itself.

func GitHubServerBaseURL added in v0.57.0

func GitHubServerBaseURL(serverURL string) string

GitHubServerBaseURL returns "https://<host>" for a GitHub server URL naming a host other than github.com. It returns "" for empty input, github.com, and any value that is not a bare HTTPS origin (userinfo, a path, a query or a fragment), so a malformed value never widens the default allowlist. The CLI derives the agents-repo fallback host from it too, so that host and the allowlist entries always agree.

func IsAgentExplicitlyDisabled added in v0.33.0

func IsAgentExplicitlyDisabled(agents []AgentEntry, name string) bool

IsAgentExplicitlyDisabled returns true if the last config entry matching name has Enabled explicitly set to false. Iterates in reverse to respect last-writer-wins ordering.

func IsBuiltinAgentName added in v0.57.0

func IsBuiltinAgentName(name string) bool

IsBuiltinAgentName reports whether name is one of the built-in agents fullsend dispatches by name (ValidAgentNames), whether or not its entry has a source. Built-in agents keep resolving through the agents-repo fallback even without a config entry, so their absence from a candidate's agent list is not a removal.

func IsPerRepoYAML added in v0.31.0

func IsPerRepoYAML(data []byte) bool

IsPerRepoYAML reports whether raw YAML parses and is free of the top-level keys of the removed per-org configuration format (dispatch, repos, defaults). A per-repo config never has those keys, while a per-org config always did, so their presence identifies a leftover per-org file that must be rejected rather than loaded.

func ManagedConfigSchema added in v0.48.0

func ManagedConfigSchema() reflect.Type

ManagedConfigSchema returns the struct type whose yaml tags define the fields a managed configuration block accepts. Manifest editors walk it to resolve config paths without keeping a separate list of keys.

func ManagedConfigSchemaDependent added in v0.56.0

func ManagedConfigSchemaDependent(data []byte) bool

ManagedConfigSchemaDependent reports whether data, a per-repo configuration document, declares anything the known schema versions do not all read the same way: tracker, create_issues, or a harness: block on an agents: entry. A document without them renders identically, and is read identically, under every known schema. Blank or unparseable content is not schema-dependent.

func MigrateLegacyTrackingYAML added in v0.55.0

func MigrateLegacyTrackingYAML(data []byte, defaultProvider string) ([]byte, bool, error)

MigrateLegacyTrackingYAML converts the legacy issue-tracking keys of a single per-repo configuration document (a .fullsend/config.yaml) into the tracker mapping, with defaultProvider as the provider when the document names none. It reports whether anything changed; unchanged or malformed input is returned as is so the regular parser reports it.

func ParseManagedConfigSchemaDeclaration added in v0.56.0

func ParseManagedConfigSchemaDeclaration(data []byte) (int, error)

ParseManagedConfigSchemaDeclaration parses the content of a ManagedConfigSchemaDeclarationPath file: lines starting with "#" and blank lines are ignored, and exactly one remaining line must hold a positive integer schema version.

func PerRepoDefaultRoles added in v0.8.0

func PerRepoDefaultRoles() []string

PerRepoDefaultRoles returns agent roles for per-repo installation. The "fullsend" dispatch role is excluded because per-repo mode uses the target repo's shim workflow for dispatch instead of a separate app.

func ProgressHidesText added in v0.57.0

func ProgressHidesText(level string) bool

ProgressHidesText reports whether a level leaves reasoning and reply text out of the live log: tools, quiet, or any unknown non-empty level. Empty counts as full.

func ProgressIsQuiet added in v0.57.0

func ProgressIsQuiet(level string) bool

ProgressIsQuiet reports whether a level prints only lines fullsend writes from its own fields. An unknown non-empty level counts as quiet, so a bad value never prints more. Empty counts as full.

func ReadLegacyTracking added in v0.55.0

func ReadLegacyTracking(node *yaml.Node, inherited LegacyTracking) (LegacyTracking, TrackingLayerKind, error)

ReadLegacyTracking reads the tracker and create_issues keys of the configuration mapping node and returns the selection in effect at that layer, given the selection it inherits, together with the kind of keys the layer declares. node may be nil (a layer with no configuration). A legacy layer whose keys cannot be combined with the inherited selection without guessing returns an error naming the edit to make. The node is not modified.

func RenderManagedConfigSchema added in v0.56.0

func RenderManagedConfigSchema(data []byte, version int) ([]byte, error)

RenderManagedConfigSchema converts data, a per-repo configuration document rendered in the current schema (ManagedConfigSchemaVersion), into the shape schema version reads. The current schema returns data unchanged. An older schema cannot express an agents: entry's harness: block. For the legacy schema the tracker mapping is also rewritten to the scalar tracker key plus create_issues.allow_targets. Settings a schema cannot express (a harness: block, GitLab groups, any Jira setting) return an error rather than being dropped. An unknown version returns an error.

func ReplaceLegacyTracking added in v0.55.0

func ReplaceLegacyTracking(node *yaml.Node, t *TrackingConfig) error

ReplaceLegacyTracking removes the legacy tracker scalar and create_issues keys from the configuration mapping node and sets tracker to t, at the position of the replaced key. A nil t only removes the legacy keys.

func ReservedSubagentKeys added in v0.42.0

func ReservedSubagentKeys() []string

ReservedSubagentKeys returns the persona names reserved by the runtime (in addition to the run's own agent name and ValidAgentNames).

func ResolveArtifactContent added in v0.56.0

func ResolveArtifactContent(r PerRepoConfigReader, source string) (string, error)

ResolveArtifactContent returns the run artifact level for a run started from source: the stricter of the effective artifacts.content and the effective artifacts.by_source entry for source. A source with no entry gets the content level. The source is trimmed and lowercased before the lookup; a by_source key that is not lowercase is an error. An empty source means the run's source is unknown: it gets the strictest of content and every by_source entry, so a source level is never skipped because the source could not be read. A nil reader (no configuration) resolves to "all". An invalid level in any layer is an error, so callers can fail closed.

func ResolveProgressVerbosity added in v0.57.0

func ResolveProgressVerbosity(r PerRepoConfigReader, source string) (string, error)

ResolveProgressVerbosity returns the live progress log level for a run started from source: the stricter of the effective progress.verbosity and the effective progress.by_source entry for source. A source with no entry gets the verbosity level. The source is trimmed and lowercased before the lookup; a by_source key that is not lowercase is an error. An empty source means the run's source is unknown: it gets the strictest of verbosity and every by_source entry, so a source level is never skipped because the source could not be read. A nil reader (no configuration) resolves to "full". An invalid level in any layer is an error; callers log at "quiet" when it fails (ADR 0163).

func SafetyRelaxationKeys added in v0.44.0

func SafetyRelaxationKeys(rs []SafetyRelaxation) []string

SafetyRelaxationKeys returns the affected configuration keys in order.

func ScopeJQLToProject added in v0.55.0

func ScopeJQLToProject(project, query string) string

ScopeJQLToProject scopes query to project as `project = "<project>" AND (<predicate>)`, keeping a trailing ORDER BY clause after the closing parenthesis. The ORDER BY is located outside quoted strings, so a predicate that mentions "order by" inside a quoted value is not split. An empty predicate (a query that is only an ORDER BY clause) yields `project = "<project>"` plus the ORDER BY.

func SetAgentHarnessCheck added in v0.57.0

func SetAgentHarnessCheck(f func(*AgentHarness) error)

SetAgentHarnessCheck registers the check Validate runs on a block's content, so config and manifest validation reject what is wrong with a block by itself (ADR 0162 Decision 2).

func StricterArtifactContent added in v0.56.0

func StricterArtifactContent(a, b string) string

StricterArtifactContent returns the stricter of two levels. An empty level counts as "all".

func StricterProgressVerbosity added in v0.57.0

func StricterProgressVerbosity(a, b string) string

StricterProgressVerbosity returns the stricter of two levels. An empty level counts as "full".

func ValidAgentNames added in v0.38.0

func ValidAgentNames() []string

ValidAgentNames returns the built-in agents fullsend dispatches by name — the names an agents: entry may tune without a source. These are the names passed to `fullsend run <agent>` and used by workflow stages. They are NOT harness role: values — "code" and "fix" both carry role: coder.

func ValidArtifactContentLevels added in v0.56.0

func ValidArtifactContentLevels() []string

ValidArtifactContentLevels returns the accepted artifacts.content and artifacts.by_source values, from least to most strict.

func ValidAuthorizationProviders added in v0.44.0

func ValidAuthorizationProviders() []string

ValidAuthorizationProviders returns the set of recognized authorization provider names.

func ValidConfigAgentName added in v0.44.0

func ValidConfigAgentName(name string) bool

ValidConfigAgentName reports whether name is acceptable as an agents: entry name. Exported so a caller that generates an agent can apply the same rule before writing anything, rather than discovering the mismatch when registration fails after the files are already on disk.

func ValidEffort added in v0.38.0

func ValidEffort(level string) bool

ValidEffort reports whether level is an accepted effort value.

func ValidEffortLevels added in v0.38.0

func ValidEffortLevels() []string

ValidEffortLevels returns the accepted effort values, in documentation order.

func ValidGatewayAPIs added in v0.47.0

func ValidGatewayAPIs() []string

ValidGatewayAPIs returns the accepted per-model "api" values for an inference.gateway model list.

func ValidGatewayAuthModes added in v0.47.0

func ValidGatewayAuthModes() []string

ValidGatewayAuthModes returns the accepted inference.gateway.auth values.

func ValidGatewayMessagesAuthHeaders added in v0.48.1

func ValidGatewayMessagesAuthHeaders() []string

ValidGatewayMessagesAuthHeaders returns the accepted inference.gateway.messages_auth_header values.

func ValidJiraLabelModes added in v0.54.0

func ValidJiraLabelModes() []string

ValidJiraLabelModes returns the accepted values of the jira authorization provider's labels: field, in documentation order.

func ValidModelAliasKeys added in v0.42.0

func ValidModelAliasKeys() []string

ValidModelAliasKeys returns the accepted alias keys for models.aliases.

func ValidModelRef added in v0.38.0

func ValidModelRef(ref string) bool

ValidModelRef reports whether ref is a well-formed model reference (single segment or provider/id form). Exported for use by harness validation and per-run override validation.

func ValidProgressVerbosities added in v0.57.0

func ValidProgressVerbosities() []string

ValidProgressVerbosities returns the accepted progress.verbosity and progress.by_source values, from least to most strict.

func ValidProviders added in v0.0.3

func ValidProviders() []string

ValidProviders returns the set of recognized inference providers.

func ValidRoles

func ValidRoles() []string

ValidRoles returns the set of agent roles accepted in `.fullsend` `roles:` config. This is intentionally narrower than mintcore's canonical roles: mint-only dogfood roles (e.g. scribe) can be registered with `fullsend mint add-role` before scaffold/workflow wiring lands, and must not silently pass config validation.

func ValidRuntimes added in v0.30.0

func ValidRuntimes() []string

ValidRuntimes returns the set of recognized agent runtimes. "pi" (#6464), "codex" (#6920), and "opencode" (#6035, unbound-force#510) are opt-in per repo, per agent, or as a repos.yaml default; "dummy" and "dummy-playback" are for behaviour tests only.

NOTE: opencode does not yet provide sandbox hooks for write-capable agents (code, fix). The exit-97 guard is keyed on security.enabled, not agent role: with security enabled it requires the adapter, while disabling security does not block write-capable roles. Role-aware enforcement is deferred to unbound-force#515 with the hook adapter.

func ValidSubagentKey added in v0.42.0

func ValidSubagentKey(key string) bool

ValidSubagentKey reports whether key is a well-formed sub-agent persona name: lowercase alphanumeric segments joined by hyphens, or "default". Maximum 64 characters.

func ValidateAgentEntries added in v0.25.0

func ValidateAgentEntries(agents []AgentEntry, allowlist []string) error

ValidateAgentEntries validates a complete, self-contained agent list — a per-repo config with its full parent chain resolved — enforcing both the allowlist check and the compiled-in-name requirement. See validateAgentEntries for the relaxed checks used during repos.yaml config overlay validation (ADR 0122).

func ValidateAgentEntriesAt added in v0.57.0

func ValidateAgentEntriesAt(agents []AgentEntry, positions []int, allowlist []string) error

ValidateAgentEntriesAt is ValidateAgentEntries for a subset of a config's agents list: positions[i] is agents[i]'s index in the full list, and errors report it as agents[N] so they point at the entry in config.yaml rather than its index within the subset. positions must have one element per entry.

func ValidateGatewayCompat added in v0.47.0

func ValidateGatewayCompat(compat map[string]any, api string) error

ValidateGatewayCompat checks a model's compat map the way extension v0.1.1 reads it (src/config.ts and validateCompat in src/compat.ts), but refuses what the extension would drop with a warning:

  • flag names match COMPAT_KEY_RE;
  • a flag the model's api declares must have that transport's type (with api empty, the type of any transport that declares it); structured fields such as allowedFallbackModels are refused;
  • any other value is a boolean, a string or a finite number, under a name that does not look like a credential or header.

Holding values to these scalar types also keeps nested data (including the map[interface{}]interface{} yaml.v3 builds for a non-string-keyed mapping) out of the rendered file, and makes the one-level copy in cloneGatewayModels a full copy. Free-text string values cannot be scanned for secrets; the name filter and the typed known flags narrow where one could go.

func ValidateGatewayModelID added in v0.47.0

func ValidateGatewayModelID(id string) error

ValidateGatewayModelID applies the extension's model-id rule (v0.1.1 src/config.ts isValidModelId): 1-256 characters, no whitespace and no control characters. The extension skips any other id with a warning, so a run would otherwise fail later with "model not found".

func ValidateGatewayModelsFilePath added in v0.47.0

func ValidateGatewayModelsFilePath(p string) error

ValidateGatewayModelsFilePath checks that p is a clean, relative repository path that stays inside the repository.

func ValidateGatewayURL added in v0.47.0

func ValidateGatewayURL(raw string) error

ValidateGatewayURL checks that raw is a usable gateway URL (ParseGatewayURL).

func ValidateManagedLayer added in v0.44.0

func ValidateManagedLayer(w PerRepoConfigWriter) error

ValidateManagedLayer validates a single repos.yaml managed-configuration layer (defaults.config, github.config, gitlab.config, or one repository's config block, ADR 0122) in isolation, before the layers are merged. It runs the same locally-set field checks as Validate, plus structural checks on this layer's own agent entries (name format, duplicate names, URL scheme and integrity hash) — but it does not check a URL agent against an allowlist (another layer may supply the allowed_remote_resources prefix) and does not require an override-only entry (no source) to name a compiled-in agent (it may tune a custom agent registered in config.base.yaml, which this layer cannot see). Those two checks run in ValidateMergedManaged once the layers are merged.

func ValidateMergedManaged added in v0.44.0

func ValidateMergedManaged(w PerRepoConfigWriter) error

ValidateMergedManaged validates a repos.yaml managed configuration (ADR 0122) after defaults.config, the platform config, and the repository config have been merged (mergeManagedConfig). A URL-sourced agent entry is checked against the effective allowlist — the resolved list with fullsend's default prefixes ensured on a non-empty result, the same list every command family resolves through EffectiveAllowedResources; an explicit [] as the resolved value still denies all remote resources. Every writer reaching this function carries the perRepoDefaults terminal parent, so the accessor already resolves the defaults and the explicit call records the rule. A managed block that declares its list validates the same for the prefixes the merged managed blocks resolve once it is written and read through LayeredConfig; a prefix declared only in config.base.yaml or a config_base preset is not visible here, so validation is stricter than the read for that shape. A block that omits the key validates against the defaults alone and still inherits a base [] (deny-all) at LayeredConfig read time, which this validation cannot see. An override-only entry is still not required to name a compiled-in agent, since config.base.yaml — which may register the agent it tunes — is not layered on until the managed file is written and later read through LayeredConfig.

func ValidateModelAliases added in v0.42.0

func ValidateModelAliases(aliases map[string]string) error

ValidateModelAliases checks a models.aliases map: every key is one of ValidModelAliasKeys, every value is a ValidModelRef, and no value is itself an alias key — the runtimes consult the alias table once, so `sonnet: opus` would reach the provider as the literal id "opus". Exported because the run path validates the effective (merged) map (nothing writes the block through the CLI, so Validate on the write paths alone would never see a hand-edited file).

func ValidateRuntimeAuthorization added in v0.54.0

func ValidateRuntimeAuthorization(r ConfigReader) error

ValidateRuntimeAuthorization runs the authorization provider checks on a config loaded with LoadConfig. Readers that do not carry authorization providers pass trivially.

func ValidateRuntimeSecretSources added in v0.57.0

func ValidateRuntimeSecretSources(r ConfigReader) error

ValidateRuntimeSecretSources validates the connections and secrets of a config loaded with LoadConfig. Readers without the mappings pass.

func ValidateTraceContext added in v0.56.0

func ValidateTraceContext(tc *TraceContextConfig) error

ValidateTraceContext checks a trace_context block; nil is valid. A non-nil block must be complete: installation_id (32 lowercase hex characters, not all zero), signing_key.secret (exactly TraceSigningKeySecret) and verification_keys.active. The active key and each retained key must be standard base64 of 32 bytes, and no two keys may share a key ID. Errors name the field path, for example trace_context.verification_keys.retained[1], and never contain the value. validateLocalFields calls it on the write path, and runAgent on the run path, because fullsend run never calls Validate.

func VaultEligibleSecretNames added in v0.57.0

func VaultEligibleSecretNames() []string

VaultEligibleSecretNames returns the runner secrets that may select a non-native connection (ADR 0155): user-managed values whose lifecycle Fullsend does not create or rotate.

Types

type AgentEntry

type AgentEntry struct {
	Name      string             `yaml:"name,omitempty"`
	Source    string             `yaml:"source,omitempty"`
	Ref       string             `yaml:"ref,omitempty"`
	Enabled   *bool              `yaml:"enabled,omitempty"`
	Runtime   string             `yaml:"runtime,omitempty"`
	Model     string             `yaml:"model,omitempty"`
	Effort    string             `yaml:"effort,omitempty"`
	Subagents map[string]*string `yaml:"subagents,omitempty"`
	Trigger   string             `yaml:"trigger,omitempty"`
	Harness   *AgentHarness      `yaml:"harness,omitempty"`
	// contains filtered or unexported fields
}

AgentEntry represents a registered agent source in config. It supports both string shorthand (just the source URL/path) and object form (with an explicit name override).

Enabled controls whether the agent participates in the merged agent set. When nil (omitted) the agent defaults to enabled. When explicitly set to false the agent is suppressed — this allows disabling built-in scaffold agents without removing their role. A suppression-only entry (Enabled=false, no Source) is valid.

Ref records the original branch or tag ref that was resolved to a commit SHA when the agent was adopted via `agent add`. When present, `agent update` re-resolves against this ref instead of the repo's default branch, so agents adopted from non-default branches stay on their intended branch across updates. Empty for entries that predate this field or were adopted with an explicit commit SHA.

Runtime, Model and Effort tune how the agent runs (ADR 0091): they override the repo-wide runtime: key and the harness model:/effort: for this agent, beneath the per-run --runtime/--model/--effort flags and FULLSEND_* variables. An enabled entry may carry them without a Source — an override-only entry — when Name is a built-in agent (ValidAgentNames) or matches a sourced entry in a parent layer; the built-in keeps resolving through the agents-repo fallback.

Trigger is a CEL boolean over the normalized event (ADR 0061). It decides routing for the built-in review, retro, triage and prioritize agents only (fullsend dispatch --route <agent>); CEL dispatch and the Jira poller keep using the harness trigger:. An omitted or empty value inherits the parent layer's.

Subagents maps persona names to model references, controlling which model each sub-agent persona runs on. The "default" key sets the fallback for personas without an explicit entry. A nil *string value tombstones an inherited entry (per-key layered merge, like ConfigModelAliases). Values are ValidModelRef through the repo alias table. Keys must match ValidSubagentKey.

Harness is a partial harness composed on the agent's harness as a child layer (ADR 0162); see AgentHarness. The keyed merge keeps a parent layer's block as a layer of its own beneath the overlay's.

func AgentSettingsFor added in v0.38.0

func AgentSettingsFor(agents []AgentEntry, name string) (AgentEntry, bool)

AgentSettingsFor returns the entry for name (case-insensitive) from an effective (merged) agent list, and whether one exists. Callers read Runtime/Model/Effort from it.

func UpsertAgentSettings added in v0.38.0

func UpsertAgentSettings(agents []AgentEntry, name, runtime, model, effort string, subagents map[string]*string) []AgentEntry

UpsertAgentSettings sets runtime/model/effort/subagents for name on a layer's local agent list: on the entry with that name when present, else as a new override-only entry. An empty value clears that setting. Returns the updated list.

func (AgentEntry) DerivedName added in v0.24.0

func (a AgentEntry) DerivedName() string

DerivedName returns the explicit Name if set, otherwise derives one from the Source filename (e.g. "triage.yaml" → "triage").

func (AgentEntry) HarnessBlocks added in v0.57.0

func (a AgentEntry) HarnessBlocks() []*AgentHarness

HarnessBlocks returns the entry's non-empty harness: blocks in composition order: the blocks of parent config layers (config.base.yaml first), then the entry's own.

func (AgentEntry) HasSettings added in v0.38.0

func (a AgentEntry) HasSettings() bool

HasSettings reports whether the entry tunes runtime, model, effort, subagents, trigger or harness fields.

func (AgentEntry) IsEnabled added in v0.33.0

func (a AgentEntry) IsEnabled() bool

IsEnabled returns whether the agent entry is enabled. A nil Enabled pointer (field omitted) defaults to true.

func (AgentEntry) IsOverrideOnly added in v0.38.0

func (a AgentEntry) IsOverrideOnly() bool

IsOverrideOnly reports whether the entry only tunes an agent defined elsewhere: enabled, no source, at least one setting.

func (*AgentEntry) UnmarshalYAML added in v0.24.0

func (a *AgentEntry) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler so that a plain string is treated as a source-only entry, while a mapping decodes normally. Old-format entries (role/name/slug identity tuples from pre-ADR-0058 config) are detected and rejected with a clear error message.

type AgentHarness added in v0.57.0

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

AgentHarness is an agents: entry's harness: block (ADR 0162): a partial harness composed on the agent's harness as a child layer, with nothing pinned, so a repository can change harness settings without writing a base: harness. The config package keeps the block as YAML; the harness package decodes it and composes it.

func HarnessBlocksFor added in v0.57.0

func HarnessBlocksFor(agents []AgentEntry, name string) []*AgentHarness

HarnessBlocksFor returns the harness: blocks of name's entry in an effective (merged) agent list, the entry AgentSettingsFor reads: nil when there is none or it is disabled, since a disabled agent does not run (ADR 0162).

func (*AgentHarness) CheckKeys added in v0.57.0

func (h *AgentHarness) CheckKeys() error

CheckKeys rejects the fields a block may not set, at its top level and, for runner_env, in its overlays, and a key with a control character.

func (*AgentHarness) DecodeStrict added in v0.57.0

func (h *AgentHarness) DecodeStrict(out any) error

DecodeStrict decodes the block into out, failing on a key out does not define (ADR 0162 Decision 2: an unknown key fails).

func (*AgentHarness) IsEmpty added in v0.57.0

func (h *AgentHarness) IsEmpty() bool

IsEmpty reports whether the block sets nothing. Nil-safe.

func (AgentHarness) MarshalYAML added in v0.57.0

func (h AgentHarness) MarshalYAML() (any, error)

MarshalYAML writes the block back as it was read.

func (*AgentHarness) Sets added in v0.57.0

func (h *AgentHarness) Sets(key string) bool

Sets reports whether the block sets key at its top level. Nil-safe.

func (*AgentHarness) UnmarshalYAML added in v0.57.0

func (h *AgentHarness) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML keeps the block's mapping node, with its YAML aliases and merge keys resolved (plainYAML). A null block decodes to a nil *AgentHarness without calling this method.

func (*AgentHarness) Validate added in v0.57.0

func (h *AgentHarness) Validate() error

Validate checks the block's keys (CheckKeys), then runs the harness package's check of the block's content (SetAgentHarnessCheck).

type AgentLister added in v0.31.0

type AgentLister interface {
	AgentEntries() []AgentEntry
}

AgentLister provides read access to registered agent entries.

type AllowedResourcesReader added in v0.31.0

type AllowedResourcesReader interface {
	AllowedResources() []string
}

AllowedResourcesReader provides read access to the allowed remote resources list.

type ArtifactsConfig added in v0.56.0

type ArtifactsConfig struct {
	Content  string            `yaml:"content,omitempty"`
	BySource map[string]string `yaml:"by_source,omitempty"`
}

ArtifactsConfig is the artifacts: block of config.yaml (ADR 0161).

Content applies to every run; empty inherits the parent layer (code default "all"). BySource maps a run source — the normalized event's source.system ("github", "gitlab", "jira", "manual", "schedule", or any later source) — to a level for runs started there. Keys are open strings; only the levels are validated. BySource merges per key through the layers.

func (*ArtifactsConfig) IsZero added in v0.56.0

func (a *ArtifactsConfig) IsZero() bool

IsZero reports whether the block sets nothing.

type AuthorizationProvider added in v0.44.0

type AuthorizationProvider struct {
	Provider string         `yaml:"provider"`
	Write    *JiraActorList `yaml:"write,omitempty"`
	Triage   *JiraActorList `yaml:"triage,omitempty"`
	Labels   string         `yaml:"labels,omitempty"`
}

AuthorizationProvider identifies an opt-in authorization backend that supplements the default collaborator-API permission check.

Write, Triage, and Labels apply only to the jira provider: they map Jira groups and account IDs to the Fullsend write and triage roles, and pick the rule for Jira label-added events.

func (*AuthorizationProvider) EffectiveJiraLabels added in v0.54.0

func (p *AuthorizationProvider) EffectiveJiraLabels() string

EffectiveJiraLabels returns the jira provider's labels: rule, defaulting to JiraLabelsEditors when it is unset or p is nil.

func (*AuthorizationProvider) HasJiraLists added in v0.54.0

func (p *AuthorizationProvider) HasJiraLists() bool

HasJiraLists reports whether the jira provider sets a write: or triage: list, even an empty one. When it does, the lists are authoritative for Jira actors (an actor they do not name is denied) and the Jira project role roster is not consulted for them.

func (*AuthorizationProvider) UnmarshalYAML added in v0.54.0

func (p *AuthorizationProvider) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler. Per-repo config is decoded without strict field checking, so a jira provider entry's keys (and its write:/triage: keys) are checked here: a misspelled key would otherwise be dropped silently and change who is authorized. The labels: value and list entries are checked here too, because the jira-poll driver loads config without running Validate.

type CommentNotificationConfig added in v0.15.0

type CommentNotificationConfig struct {
	Start      string `yaml:"start,omitempty"`
	Completion string `yaml:"completion,omitempty"`
}

CommentNotificationConfig controls start/completion comments. Valid start values: "enabled" (default), "disabled". Valid completion values: "enabled" (default), "on_failure", "disabled".

type ConfigReader added in v0.31.0

ConfigReader is the common read interface for the general-purpose configuration fields. Consumer packages should depend on this interface rather than accessing struct fields directly.

func LoadConfig added in v0.31.0

func LoadConfig(dir string, opts LoadOpts) (ConfigReader, error)

LoadConfig reads config.yaml (and config.base.yaml if present) from dir, returning a ConfigReader. The parent chain is wired as overlay (config.yaml) → base (config.base.yaml) → code defaults. A config.yaml in the removed per-org format is rejected. This is the preferred entry point for consumer packages that only need read access.

type ConfigWriter added in v0.31.0

type ConfigWriter interface {
	ConfigReader
	SetKillSwitch(bool)
	SetAgents([]AgentEntry)
	SetAllowedRemoteResources([]string)
	SetStatusNotifications(*StatusNotificationConfig)
	Marshal() ([]byte, error)
	Validate() error
	// ValidateGlobal is Validate without the agents[] entry checks.
	ValidateGlobal() error
}

ConfigWriter extends ConfigReader with mutation methods for the general-purpose configuration fields.

func LoadConfigWriter added in v0.32.0

func LoadConfigWriter(dir string, opts LoadOpts) (ConfigWriter, error)

LoadConfigWriter reads config.yaml (and config.base.yaml if present) from dir, returning a ConfigWriter. The parent chain is wired as overlay (config.yaml) → base (config.base.yaml) → code defaults, and a config.yaml in the removed per-org format is rejected. Only the overlay layer is mutable; base and defaults are read-only via the parent pointer. This is the preferred entry point for consumer packages that need read-write access (e.g. CLI commands that modify and write-back config).

type DeclaredInfrastructure added in v0.48.0

type DeclaredInfrastructure struct {
	MintURL              string
	InferenceProject     string
	InferenceRegion      string
	InferenceWIFProvider string
	// InferenceWIFAudience and InferenceServiceAccount are the GitLab
	// vertex-wif options for an existing WIF provider: the agent job's ID
	// token audience and the service account it impersonates.
	InferenceWIFAudience    string
	InferenceServiceAccount string
	// InferenceGateway is the layered inference.gateway block (trimmed).
	// It is zero when no layer declares one; a partial block is returned
	// as declared so callers can report what is missing.
	InferenceGateway InferenceGatewayConfig
}

DeclaredInfrastructure holds the installation infrastructure values that a managed overlay or a config.base.yaml preset explicitly declares. Unlike the layered accessors it never falls back to code defaults: an empty field means no layer declares the value.

func DeclaredInfrastructureValues added in v0.48.0

func DeclaredInfrastructureValues(overlay PerRepoConfigWriter, baseYAML []byte) (DeclaredInfrastructure, error)

DeclaredInfrastructureValues returns the mint URL, Vertex inference and inference gateway values declared by overlay (which wins) or by baseYAML. baseYAML may be empty. Code defaults are deliberately not consulted, so callers can tell a declared value from an inherited default.

type GatewayURL added in v0.47.1

type GatewayURL struct {
	// Origin is scheme://host[:port], with no trailing slash.
	Origin string
	// Hostname is the host without a port, as written.
	Hostname string
	// Prefix is the optional path prefix the gateway serves its API
	// under: "" for a bare origin, otherwise a clean absolute path with no
	// trailing slash, for example "/team-a".
	Prefix string
}

GatewayURL is a validated inference.gateway.url split into the parts the runner builds on (ParseGatewayURL).

func ParseGatewayURL added in v0.47.1

func ParseGatewayURL(raw string) (GatewayURL, error)

ParseGatewayURL checks that raw is the gateway's URL and splits it: an absolute https URL with a host, an optional path prefix (GatewayPathPrefix), no port other than 443, and no embedded credentials, query or fragment. The runner appends the /v1/... model API paths itself, and the OpenShell egress profile binds the host on port 443 only. Plain http, and any port, is accepted only for a loopback host (test servers), as actionsoidc.RequireSecureURL does.

func (GatewayURL) BaseURL added in v0.47.1

func (g GatewayURL) BaseURL() string

BaseURL returns Origin followed by Prefix: the URL the runtimes add GatewayAPIBasePath and the model API paths to.

type GitHubAllowedTargets added in v0.55.0

type GitHubAllowedTargets struct {
	Orgs  []string `yaml:"orgs,omitempty"`
	Repos []string `yaml:"repos,omitempty"`
}

GitHubAllowedTargets lists the GitHub destinations agents may create issues in beyond the source repository. The scopes are additive: a destination is allowed if its owner is listed in Orgs or the repository is listed in Repos.

type GitHubTrackingConfig added in v0.55.0

type GitHubTrackingConfig struct {
	AllowedTargets GitHubAllowedTargets `yaml:"allowed_targets"`
}

GitHubTrackingConfig holds GitHub issue-tracking settings.

type GitLabAllowedTargets added in v0.55.0

type GitLabAllowedTargets struct {
	Groups []string `yaml:"groups,omitempty"`
	Repos  []string `yaml:"repos,omitempty"`
}

GitLabAllowedTargets lists the GitLab destinations agents may create issues in beyond the source project. The scopes are additive: a destination is allowed if it is inside a group listed in Groups or its full project path is listed in Repos.

type GitLabTrackingConfig added in v0.55.0

type GitLabTrackingConfig struct {
	AllowedTargets GitLabAllowedTargets `yaml:"allowed_targets"`
}

GitLabTrackingConfig holds GitLab issue-tracking settings.

type InferenceGatewayConfig added in v0.47.0

type InferenceGatewayConfig struct {
	URL                string                           `yaml:"url,omitempty"`
	Audience           string                           `yaml:"audience,omitempty"`
	Auth               string                           `yaml:"auth,omitempty"`
	MessagesAuthHeader string                           `yaml:"messages_auth_header,omitempty"`
	Models             map[string]InferenceGatewayModel `yaml:"models,omitempty"`
	ModelsFile         string                           `yaml:"models_file,omitempty"`
}

InferenceGatewayConfig is the inference.gateway block (ADR 0137): a self-hosted, OpenAI/Anthropic-compatible gateway. Auth selects the credential mode (EffectiveAuth): oidc (the default) presents the job's forge OIDC token and requires Audience; api-key presents a gateway API key and needs no audience. MessagesAuthHeader selects the header the credential travels in on Messages-dialect requests (EffectiveMessagesAuthHeader; ADR 0142). URL is always required (see Missing). The model list is optional at block level and takes exactly one of two forms: Models (inline) or ModelsFile (a repository path to a file in the pi-inference-gateway extension's own config format). A runtime that cannot discover models (pi under PI_OFFLINE) requires one when a gateway/ model is resolved.

There is deliberately no runner-variable override: the committed config is the single source, and pull-request events read it from the base branch, so a pull request cannot redirect its own run.

func (InferenceGatewayConfig) EffectiveAuth added in v0.47.0

func (c InferenceGatewayConfig) EffectiveAuth() string

EffectiveAuth returns the block's credential mode: Auth, or GatewayAuthOIDC when it is unset.

func (InferenceGatewayConfig) EffectiveMessagesAuthHeader added in v0.48.1

func (c InferenceGatewayConfig) EffectiveMessagesAuthHeader() string

EffectiveMessagesAuthHeader returns the header the credential travels in on Messages-dialect requests: MessagesAuthHeader, or GatewayMessagesAuthHeaderAuthorization when it is unset.

func (InferenceGatewayConfig) HasModelList added in v0.47.0

func (c InferenceGatewayConfig) HasModelList() bool

HasModelList reports whether either model-list form is set.

func (InferenceGatewayConfig) IsAPIKey added in v0.47.0

func (c InferenceGatewayConfig) IsAPIKey() bool

IsAPIKey reports whether the block uses the api-key credential mode.

func (InferenceGatewayConfig) IsZero added in v0.47.0

func (c InferenceGatewayConfig) IsZero() bool

IsZero reports whether no field is set.

func (InferenceGatewayConfig) MessagesUseXAPIKey added in v0.48.1

func (c InferenceGatewayConfig) MessagesUseXAPIKey() bool

MessagesUseXAPIKey reports whether Messages-dialect requests carry the credential as x-api-key instead of Authorization: Bearer.

func (InferenceGatewayConfig) Missing added in v0.47.0

func (c InferenceGatewayConfig) Missing() []string

Missing lists the required fields still unset, in a fixed order, so a partial block can be reported precisely: url always, and audience in the oidc mode (the api-key mode requests no OIDC assertion). The model list is not required at block level: it is checked when a runtime that needs it resolves a gateway/ model.

func (InferenceGatewayConfig) ModelIDs added in v0.47.0

func (c InferenceGatewayConfig) ModelIDs() []string

ModelIDs returns the inline model ids in sorted order.

func (InferenceGatewayConfig) Trimmed added in v0.47.0

Trimmed returns the block with surrounding whitespace removed from the scalar fields, so a whitespace-only YAML value counts as unset. Models is copied (shallowly per entry) so the result does not alias the receiver's map.

func (InferenceGatewayConfig) Validate added in v0.47.0

func (c InferenceGatewayConfig) Validate() error

Validate checks the block's set fields. It does not enforce all-or-none on url + audience, because the block layers field by field (an org preset may carry url and audience while a repository adds its models); callers that resolved the effective block check Missing.

func (InferenceGatewayConfig) ValidateEffective added in v0.48.1

func (c InferenceGatewayConfig) ValidateEffective() error

ValidateEffective checks a resolved (layered) block: Validate, plus the rules that span fields a single layer may not all set. messages_auth_header: x-api-key needs the api-key mode, and the mode may come from another layer (an unset auth is oidc), so Validate alone cannot refuse it.

type InferenceGatewayModel added in v0.47.0

type InferenceGatewayModel struct {
	API           string         `yaml:"api"`
	Compat        map[string]any `yaml:"compat,omitempty"`
	ContextWindow int            `yaml:"contextWindow,omitempty"`
	MaxTokens     int            `yaml:"maxTokens,omitempty"`
}

InferenceGatewayModel holds the per-model settings of an inline inference.gateway model list. Field names follow the pi-inference-gateway extension's config keys so they render verbatim.

type JiraActorList added in v0.54.0

type JiraActorList struct {
	Groups   []string `yaml:"groups,omitempty"`
	Accounts []string `yaml:"accounts,omitempty"`
}

JiraActorList names the Jira actors granted one Fullsend role by the jira authorization provider. Groups are Jira group names (or group IDs); accounts are Jira account IDs.

func (*JiraActorList) IsEmpty added in v0.54.0

func (l *JiraActorList) IsEmpty() bool

IsEmpty reports whether l lists no group and no account.

type JiraAllowedTargets added in v0.55.0

type JiraAllowedTargets struct {
	Projects []string `yaml:"projects,omitempty"`
}

JiraAllowedTargets lists the Jira projects (by key) agents may create issues in beyond the source project.

type JiraPollConfig added in v0.55.0

type JiraPollConfig struct {
	// Enabled installs (true) or removes (false) the managed poll
	// workflow. Nil means the workflow is not installed.
	Enabled *bool `yaml:"enabled,omitempty"`
	// Query is the JQL the poller runs, before project scoping; empty
	// means DefaultJiraPollQuery.
	Query string `yaml:"query,omitempty"`
}

JiraPollConfig holds the Jira poller settings.

type JiraTrackingConfig added in v0.55.0

type JiraTrackingConfig struct {
	// BaseURL is the Jira site URL (for example
	// https://example.atlassian.net). Required when any connection or
	// poll setting is present.
	BaseURL string `yaml:"base_url,omitempty"`
	// APIURL is the Jira API gateway URL; empty means DefaultJiraAPIURL.
	APIURL string `yaml:"api_url,omitempty"`
	// RunLabel is added at the start of Jira-sourced runs. Empty disables it.
	RunLabel string `yaml:"run_label,omitempty"`
	// Project is the key of the single Jira project configured for this
	// repository. Required when any connection or poll setting is present.
	Project        string             `yaml:"project,omitempty"`
	AllowedTargets JiraAllowedTargets `yaml:"allowed_targets"`
	Poll           *JiraPollConfig    `yaml:"poll,omitempty"`
}

JiraTrackingConfig holds Jira issue-tracking settings: the Jira site and project this repository is connected to, the cross-project issue destinations, and the poller settings. Credentials (the Jira token and account email) are never part of this mapping; they are supplied as repository secrets.

func (*JiraTrackingConfig) EffectiveAPIURL added in v0.55.0

func (j *JiraTrackingConfig) EffectiveAPIURL() string

EffectiveAPIURL returns api_url, or DefaultJiraAPIURL when it is unset.

func (*JiraTrackingConfig) HasConnectionSettings added in v0.55.0

func (j *JiraTrackingConfig) HasConnectionSettings() bool

HasConnectionSettings reports whether the mapping sets any setting beyond allowed_targets (base_url, api_url, project, run_label, or poll).

func (*JiraTrackingConfig) PollEnabled added in v0.55.0

func (j *JiraTrackingConfig) PollEnabled() bool

PollEnabled reports whether poll.enabled is explicitly true. An omitted poll mapping or poll.enabled means the poll workflow is not installed.

func (*JiraTrackingConfig) PollJQL added in v0.55.0

func (j *JiraTrackingConfig) PollJQL() string

PollJQL returns the poller's JQL: the configured (or default) query scoped to the repository's project (see ScopeJQLToProject).

func (*JiraTrackingConfig) PollQuery added in v0.55.0

func (j *JiraTrackingConfig) PollQuery() string

PollQuery returns poll.query, or DefaultJiraPollQuery when it is unset.

func (*JiraTrackingConfig) UnmarshalYAML added in v0.55.0

func (j *JiraTrackingConfig) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler. A custom unmarshaler drops yaml.v3's strict-field option for everything below it, so the keys of tracker.jira (and of its poll and allowed_targets mappings) are checked here. Credential-like keys get a message pointing at the repository secrets instead of the generic unknown-field error.

func (*JiraTrackingConfig) ValidateConnection added in v0.55.0

func (j *JiraTrackingConfig) ValidateConnection() error

ValidateConnection checks the Jira site, API gateway, project, and poll settings. base_url and project have no defaults, so both are required once any of these settings is present; a mapping that only selects Jira (jira: {}), such as one migrated from the legacy scalar tracker form, stays valid. Runtime loading does not run Validate, so commands that consume these settings call it directly.

func (*JiraTrackingConfig) ValidateRunLabel added in v0.56.0

func (j *JiraTrackingConfig) ValidateRunLabel() error

ValidateRunLabel checks the optional tracking label independently of Jira connection settings so a malformed label cannot stop runs or polling.

type KillSwitchReader added in v0.31.0

type KillSwitchReader interface {
	IsKillSwitchActive() bool
}

KillSwitchReader provides read access to the kill switch state.

type LegacyTracking added in v0.55.0

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

LegacyTracking is the issue-tracking selection in effect at one configuration layer, accumulated from the root layer down. The zero value is the empty root: no provider, no targets.

func (LegacyTracking) HasProvider added in v0.55.0

func (s LegacyTracking) HasProvider() bool

HasProvider reports whether the selection names a provider without falling back to a forge default.

func (LegacyTracking) Resolve added in v0.55.0

func (s LegacyTracking) Resolve(defaultProvider string) (*TrackingConfig, error)

Resolve returns the tracker mapping equivalent to the selection. defaultProvider is the provider a selection without one resolves to: the repository's forge, as the runtime used legacy create_issues targets on the hosting forge. Legacy targets that have no unambiguous equivalent under the resolved provider return an error naming the edit to make instead of being dropped or reinterpreted.

type LoadOpts added in v0.31.0

type LoadOpts struct {
	// MissingOK returns a default config when config.yaml is absent.
	MissingOK bool
}

LoadOpts controls how LoadConfig handles a missing config.yaml.

type ManagedConfig added in v0.44.0

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

ManagedConfig is a sparse per-repo managed configuration as declared in repos.yaml defaults.config, github.config, gitlab.config, and per-repository config blocks (ADR 0122). Every per-repo .fullsend/config.yaml field is accepted. The zero value means the key was omitted.

func (ManagedConfig) Clone added in v0.47.1

func (o ManagedConfig) Clone() ManagedConfig

Clone returns a deep copy of o that shares no mutable state with it: the Writer of the copy can be mutated without affecting the receiver. An unset configuration stays unset.

func (ManagedConfig) ExplicitAllowedRemoteResources added in v0.47.1

func (o ManagedConfig) ExplicitAllowedRemoteResources() ([]string, bool)

ExplicitAllowedRemoteResources returns the allowed_remote_resources list declared by this layer and whether the layer declares the key at all. An explicit empty list reports (empty, true). Unlike the layered AllowedResources accessor it does not union with or fall back to code defaults.

func (ManagedConfig) ExplicitRoles added in v0.47.0

func (o ManagedConfig) ExplicitRoles() ([]string, bool)

ExplicitRoles returns the roles declared by this layer and whether the layer declares roles at all. Unlike the layered ConfigRoles accessor it does not fall back to code defaults, so an explicit value that equals a default is still reported as declared.

func (ManagedConfig) ExplicitRuntime added in v0.47.1

func (o ManagedConfig) ExplicitRuntime() string

ExplicitRuntime returns the runtime declared by this layer, or "" when the layer is unset or omits runtime. Unlike the layered ConfigRuntime accessor it does not fall back to code defaults.

func (ManagedConfig) IsSet added in v0.44.0

func (o ManagedConfig) IsSet() bool

IsSet reports whether a config mapping was present in YAML, including an empty mapping (`config: {}`) that opts a repository into managed configuration without supplying values.

func (ManagedConfig) IsZero added in v0.44.0

func (o ManagedConfig) IsZero() bool

IsZero reports whether the managed configuration was omitted. yaml.v3 uses this for omitempty so unset blocks are not marshaled as null.

func (ManagedConfig) MarshalYAML added in v0.44.0

func (o ManagedConfig) MarshalYAML() (interface{}, error)

MarshalYAML encodes the managed configuration as a sparse mapping without the config.yaml file header.

func (*ManagedConfig) UnmarshalYAML added in v0.44.0

func (o *ManagedConfig) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML strictly decodes a mapping into a sparse per-repo managed configuration. Unknown fields are rejected with field-specific errors.

func (ManagedConfig) WithIssueTracking added in v0.55.0

func (o ManagedConfig) WithIssueTracking(t *TrackingConfig) ManagedConfig

WithIssueTracking returns a copy of o whose tracking mapping is a copy of t. It is how repos install records the upstream cross-repo permissions on a manifest entry (#8218, #8504). The receiver is not modified.

func (ManagedConfig) WithTraceContext added in v0.56.0

func (o ManagedConfig) WithTraceContext(tc *TraceContextConfig) ManagedConfig

WithTraceContext returns a copy of o whose trace_context block is a deep copy of tc; nil removes the block. The receiver is not modified.

func (ManagedConfig) Writer added in v0.44.0

Writer returns the managed configuration as a PerRepoConfigWriter, or nil if unset.

type ModelsConfig added in v0.42.0

type ModelsConfig struct {
	// Aliases overrides fullsend's pinned alias table per key.
	// Keys are alias names (opus, sonnet, haiku, fable); values are
	// model ids or provider/id specs validated with ValidModelRef.
	Aliases map[string]string `yaml:"aliases,omitempty"`
}

ModelsConfig groups model-related repo config under a single YAML key. Currently only Aliases; future keys (e.g. defaults, catalog metadata) can be added without flat-key proliferation.

type OpenAIWIFConfig added in v0.38.0

type OpenAIWIFConfig struct {
	Audience           string `yaml:"audience,omitempty"`
	IdentityProviderID string `yaml:"identity_provider_id,omitempty"`
	ServiceAccountID   string `yaml:"service_account_id,omitempty"`
}

OpenAIWIFConfig identifies the OpenAI Workload Identity provider and service-account mapping a run exchanges its GitHub OIDC token with.

func (OpenAIWIFConfig) IsZero added in v0.38.0

func (c OpenAIWIFConfig) IsZero() bool

IsZero reports whether no identifier is set.

func (OpenAIWIFConfig) Missing added in v0.38.0

func (c OpenAIWIFConfig) Missing() []string

Missing lists the identifiers still unset, in a fixed order, so a partially configured block can be reported precisely.

func (OpenAIWIFConfig) Trimmed added in v0.38.0

func (c OpenAIWIFConfig) Trimmed() OpenAIWIFConfig

Trimmed returns the identifiers with surrounding whitespace removed, so a whitespace-only YAML value counts as unset.

type PerRepoConfigReader added in v0.31.0

type PerRepoConfigReader interface {
	ConfigReader
	SecretSourcesReader
	ConfigRoles() []string
	ConfigRuntime() string
	ConfigForge() string
	ConfigTracker() string
	ConfigMintURL() string
	// ConfigMintURLFromFile returns the mint URL as set in config.yaml or
	// config.base.yaml only. Empty means neither file sets mint_url — the
	// compiled default is not consulted here (contrast with
	// ConfigMintURL, which falls all the way through to the compiled
	// default). Callers that need to distinguish "the file is silent" from
	// "the file resolves to the default" (e.g. fullsend run's
	// warn-and-skip-minting fallback) use this instead of ConfigMintURL.
	ConfigMintURLFromFile() string
	ConfigKeepHistory() bool
	ConfigInferenceProvider() string
	ConfigInferenceProject() string
	ConfigInferenceRegion() string
	ConfigInferenceWIFProvider() string
	ConfigInferenceWIFAudience() string
	ConfigInferenceServiceAccount() string
	ConfigInferenceOpenAI() OpenAIWIFConfig
	// ConfigInferenceGateway returns the effective inference.gateway
	// block, layered field by field (ADR 0137).
	ConfigInferenceGateway() InferenceGatewayConfig
	// ConfigModelAliases returns the effective model alias map, merged
	// per-key through the parent chain. nil (the code default) means no
	// aliases are configured: every alias resolves through the runtime's
	// compiled-in table.
	ConfigModelAliases() map[string]string
	// ConfigArtifactsContent returns the effective artifacts.content
	// level (ADR 0161); the code default is "all".
	ConfigArtifactsContent() string
	// ConfigArtifactsContentSet reports whether any config layer sets
	// artifacts.content explicitly (false for the code default).
	ConfigArtifactsContentSet() bool
	// ConfigArtifactsBySource returns the effective artifacts.by_source
	// map, merged per key through the parent chain. nil means no
	// per-source levels.
	ConfigArtifactsBySource() map[string]string
	// ConfigProgressVerbosity returns the effective progress.verbosity
	// level (ADR 0163); the code default is "full".
	ConfigProgressVerbosity() string
	// ConfigProgressBySource returns the effective progress.by_source
	// map, merged per key through the parent chain. nil means no
	// per-source levels.
	ConfigProgressBySource() map[string]string
	// IsOwnersFileAuthEnabled reports whether the owners_file
	// authorization provider is listed.
	IsOwnersFileAuthEnabled() bool
	// JiraAuthorization returns the jira authorization provider entry,
	// or nil when none is listed.
	JiraAuthorization() *AuthorizationProvider
	// TraceContext returns a copy of this layer's trace_context block, or
	// nil when it has none. There is no parent fallback: config.base.yaml
	// never supplies it (ADR 0154).
	TraceContext() *TraceContextConfig
}

PerRepoConfigReader extends ConfigReader with per-repo-specific fields. Methods are prefixed with "Config" to avoid conflicts with the struct field names (Roles and Runtime).

func ParsePerRepoConfig added in v0.8.0

func ParsePerRepoConfig(data []byte) (PerRepoConfigReader, error)

ParsePerRepoConfig parses YAML bytes into a PerRepoConfigReader.

type PerRepoConfigWriter added in v0.33.0

type PerRepoConfigWriter interface {
	PerRepoConfigReader
	ConfigWriter
	SetRoles([]string)
	SetRuntime(string)
	SetMintURL(string)
	SetKeepHistory(bool)
	SetInferenceProvider(string)
	SetInferenceProject(string)
	SetInferenceRegion(string)
	SetInferenceWIFProvider(string)
	SetInferenceWIFAudience(string)
	SetInferenceServiceAccount(string)
	SetInferenceOpenAI(OpenAIWIFConfig)
	SetInferenceGateway(InferenceGatewayConfig)
	// MergeInferenceGateway layers the set fields of g over this layer's
	// own inference.gateway block, the way the layers merge.
	MergeInferenceGateway(InferenceGatewayConfig)
	SetModelAliases(map[string]string)
	SetOwnersFileAuthEnabled(bool)
	SetIssueTracking(*TrackingConfig)
}

PerRepoConfigWriter extends PerRepoConfigReader and ConfigWriter with per-repo-specific mutation methods.

func LayerOnBase added in v0.44.0

func LayerOnBase(overlay PerRepoConfigWriter, baseYAML []byte) (PerRepoConfigWriter, error)

LayerOnBase returns a writer whose local fields are overlay's and whose parent chain is base → code defaults. baseYAML may be empty, in which case the parent is code defaults only. The overlay is cloned so the caller's value is not mutated.

func MergeManaged added in v0.44.0

func MergeManaged(parent, child PerRepoConfigWriter) PerRepoConfigWriter

MergeManaged combines two sparse managed-configuration layers using the per-field merge rules of per-repo config. child wins where it sets a value; unspecified child fields inherit from parent. Neither code defaults nor a config.base.yaml layer are baked in. A nil layer is treated as unset.

func NewEmptyPerRepoOverlay added in v0.36.0

func NewEmptyPerRepoOverlay() PerRepoConfigWriter

NewEmptyPerRepoOverlay creates an empty per-repo config suitable for use as a stub overlay when a preset base layer is provided. No roles, agents, or version are populated; the overlay inherits everything from the base layer via the parent fallback chain.

func NewPerRepoConfig added in v0.8.0

func NewPerRepoConfig(roles []string, targetRepo string) PerRepoConfigWriter

NewPerRepoConfig creates a new perRepoConfig with the given roles. The returned ConfigWriter provides read-write access to shared config fields; use PerRepoConfigReader type assertion for per-repo-specific methods.

func ParsePerRepoConfigWriter added in v0.33.0

func ParsePerRepoConfigWriter(data []byte) (PerRepoConfigWriter, error)

ParsePerRepoConfigWriter parses YAML bytes into a PerRepoConfigWriter for callers that need to modify the config after parsing.

func ParsePerRepoConfigWriterLayered added in v0.38.0

func ParsePerRepoConfigWriterLayered(overlayData []byte, baseData []byte) (PerRepoConfigWriter, error)

ParsePerRepoConfigWriterLayered parses overlay and optional base YAML bytes into a PerRepoConfigWriter with the parent chain overlay → base → code defaults. When baseData is nil the result is equivalent to ParsePerRepoConfigWriter (parent = code defaults only). This is the preferred entry point when both layers are available as raw bytes (e.g. fetched from a forge API) rather than on the local filesystem (where LoadConfigWriter should be used instead).

type PerRepoInferenceConfig added in v0.36.0

type PerRepoInferenceConfig struct {
	Provider    string `yaml:"provider,omitempty"`
	Project     string `yaml:"project,omitempty"`
	Region      string `yaml:"region,omitempty"`
	WIFProvider string `yaml:"wif_provider,omitempty"`
	// WIFAudience is the audience GitLab puts in the agent job's ID token
	// when the WIF provider is an existing one that accepts a different
	// audience than "fullsend". GitLab vertex-wif only; install time only.
	WIFAudience string `yaml:"wif_audience,omitempty"`
	// ServiceAccount is the email of a Google service account the GitLab
	// agent job impersonates after the federated token exchange, for
	// installs that cannot grant the federated principal project IAM roles.
	// GitLab vertex-wif only; install time only.
	ServiceAccount string `yaml:"service_account,omitempty"`
	// OpenAI holds the OpenAI Workload Identity Federation identifiers
	// (ADR 0092). They are not secrets: the mapping they name only
	// trusts a GitHub OIDC token whose claims match, and the run prints
	// them. The FULLSEND_OPENAI_* runner variables, when set, take
	// precedence over this block.
	OpenAI *OpenAIWIFConfig `yaml:"openai,omitempty"`
	// Gateway is the inference gateway credential route (ADR 0137): a
	// self-hosted gateway that validates the job's forge OIDC token. It
	// layers field by field and has no runner-variable override.
	Gateway *InferenceGatewayConfig `yaml:"gateway,omitempty"`
}

PerRepoInferenceConfig groups inference backend settings for per-repo configs. The Provider field identifies the inference backend (currently only "vertex"); Project, Region, and WIFProvider hold provider-specific connection details.

type ProgressConfig added in v0.57.0

type ProgressConfig struct {
	Verbosity string            `yaml:"verbosity,omitempty"`
	BySource  map[string]string `yaml:"by_source,omitempty"`
}

ProgressConfig is the progress: block of config.yaml (ADR 0163).

Verbosity applies to every run; empty inherits the parent layer (code default "full"). BySource maps a run source — the normalized event's source.system ("github", "gitlab", "jira", "manual", "schedule", or any later source) — to a level for runs started there. Keys are open strings; only the levels are validated. BySource merges per key through the layers.

func (*ProgressConfig) IsZero added in v0.57.0

func (p *ProgressConfig) IsZero() bool

IsZero reports whether the block sets nothing.

type ReactionNotificationConfig added in v0.38.0

type ReactionNotificationConfig struct {
	Start      string `yaml:"start,omitempty"`
	Completion string `yaml:"completion,omitempty"`
}

ReactionNotificationConfig controls start/completion emoji reactions, an alternative to comments that doesn't generate a GitHub notification. Unlike comments, both fields default to "disabled" — reactions are an opt-in addition rather than a default-on behavior. Valid start values: "enabled", "disabled" (default). Valid completion values: "enabled", "on_failure", "disabled" (default).

type SafetyRelaxation added in v0.44.0

type SafetyRelaxation struct {
	Key       string
	Current   string
	Candidate string
}

SafetyRelaxation is one candidate value that is less restrictive than the current effective configuration without an explicit local declaration in the managed configuration (ADR 0122).

func CheckManagedSafetyGate added in v0.44.0

func CheckManagedSafetyGate(current PerRepoConfigReader, candidate PerRepoConfigWriter) []SafetyRelaxation

CheckManagedSafetyGate compares current and candidate effective configurations (both already layered managed → base → code defaults). A less-restrictive candidate is reported unless candidate declares that relaxation locally. candidate must be the layered *perRepoConfig so omitted vs explicit local fields can be distinguished.

func CheckManagedSafetyGateFromLayerPairs added in v0.47.0

func CheckManagedSafetyGateFromLayerPairs(currentYAML, currentBaseYAML []byte, candidate PerRepoConfigWriter, candidateBaseYAML []byte) ([]SafetyRelaxation, error)

CheckManagedSafetyGateFromLayerPairs compares the current effective configuration (currentYAML over currentBaseYAML → code defaults) with the proposed one (candidate over candidateBaseYAML → code defaults). Use it when the base layer itself would change (a declared preset replacing an existing .fullsend/config.base.yaml), so a replacement base cannot bypass restrictions through overlay fallthrough. Only fields the candidate overlay declares locally count as explicit relaxations; a base change alone never does.

func CheckManagedSafetyGateFromLayers added in v0.44.0

func CheckManagedSafetyGateFromLayers(currentYAML []byte, candidate PerRepoConfigWriter, baseYAML []byte) ([]SafetyRelaxation, error)

CheckManagedSafetyGateFromLayers layers currentYAML (the installed .fullsend/config.yaml, or empty when the file is missing) and candidate onto the same parent chain (baseYAML → code defaults) and reports implicit relaxations. Omitted candidate keys fall through the parent chain rather than being ignored because the sparse file lacks them.

func (SafetyRelaxation) String added in v0.44.0

func (r SafetyRelaxation) String() string

type SecretConnection added in v0.57.0

type SecretConnection struct {
	Kind           string `yaml:"kind"`
	VaultAddress   string `yaml:"vault_address,omitempty"`
	VaultNamespace string `yaml:"vault_namespace,omitempty"`
	VaultAuthPath  string `yaml:"vault_auth_path,omitempty"`
	VaultRole      string `yaml:"vault_role,omitempty"`
	VaultAudience  string `yaml:"vault_audience,omitempty"`
}

SecretConnection is one entry of the top-level connections mapping: a named connection to a secret service. Kind is required; the vault_* fields are valid only with kind: vault.

type SecretSource added in v0.57.0

type SecretSource struct {
	// Connection names an entry of connections, or "native". Empty selects
	// the forge-native source.
	Connection string `yaml:"connection,omitempty"`
	// VaultSecrets is the ordered list of KV v2 API read paths, relative to
	// /v1/ and including the mount's /data/ segment.
	VaultSecrets []string `yaml:"vault_secrets,omitempty"`
}

SecretSource is one entry of the top-level secrets mapping: the connection a registered runner secret uses and, for Vault, its ordered KV v2 read paths.

type SecretSourcesReader added in v0.57.0

type SecretSourcesReader interface {
	// ConfigConnections returns the effective connections mapping, merged
	// by connection name through the parent chain. A more-specific layer
	// replaces a whole entry.
	ConfigConnections() map[string]SecretConnection
	// ConfigSecrets returns the effective secrets mapping, merged by secret
	// name through the parent chain. A more-specific layer replaces a whole
	// entry, including its vault_secrets list.
	ConfigSecrets() map[string]SecretSource
	// ValidateSecretSources checks the effective mappings.
	ValidateSecretSources() error
}

SecretSourcesReader exposes the layered connections and secrets mappings. It is embedded in PerRepoConfigReader; callers holding only a ConfigReader type-assert to it.

type StatusNotificationConfig added in v0.15.0

type StatusNotificationConfig struct {
	Comment  CommentNotificationConfig  `yaml:"comment,omitempty"`
	Reaction ReactionNotificationConfig `yaml:"reaction,omitempty"`
}

StatusNotificationConfig controls status comments and reactions posted on issues/PRs when agents start and complete.

type StatusNotificationsReader added in v0.36.0

type StatusNotificationsReader interface {
	StatusNotifications() *StatusNotificationConfig
}

StatusNotificationsReader provides read access to status notification configuration (comment start & completion).

type TraceContextConfig added in v0.56.0

type TraceContextConfig struct {
	InstallationID   string                 `yaml:"installation_id,omitempty"`
	SigningKey       *TraceSigningKeyRef    `yaml:"signing_key,omitempty"`
	VerificationKeys *TraceVerificationKeys `yaml:"verification_keys,omitempty"`
}

TraceContextConfig is the trace_context block (ADR 0154): the trace installation ID, the protected reference to the signing key and the public verification keys. Every value is public. Only a concrete repository entry in repos.yaml carries it; config.base.yaml never supplies it.

func (*TraceContextConfig) ActiveKey added in v0.56.0

func (tc *TraceContextConfig) ActiveKey() (ed25519.PublicKey, error)

ActiveKey returns the parsed active verification key of a validated block.

func (*TraceContextConfig) Installation added in v0.56.0

func (tc *TraceContextConfig) Installation() ([16]byte, error)

Installation returns the parsed installation ID of a validated block.

func (*TraceContextConfig) KeySet added in v0.56.0

func (tc *TraceContextConfig) KeySet() (map[[8]byte]ed25519.PublicKey, error)

KeySet returns the admission key map of a validated block: the active and retained keys, keyed by key ID (tracecontext.KeySet).

type TraceSigningKeyRef added in v0.56.0

type TraceSigningKeyRef struct {
	Secret string `yaml:"secret,omitempty"`
}

TraceSigningKeyRef names where the signing key lives. In v1 Secret must be TraceSigningKeySecret.

type TraceVerificationKeys added in v0.56.0

type TraceVerificationKeys struct {
	Active   string   `yaml:"active,omitempty"`
	Retained []string `yaml:"retained,omitempty"`
}

TraceVerificationKeys holds the active verification key and the retained keys that still verify envelopes signed before a rotation, each as standard base64 of a 32-byte Ed25519 public key.

type TrackingConfig added in v0.55.0

type TrackingConfig struct {
	GitHub *GitHubTrackingConfig `yaml:"github,omitempty"`
	GitLab *GitLabTrackingConfig `yaml:"gitlab,omitempty"`
	Jira   *JiraTrackingConfig   `yaml:"jira,omitempty"`
}

TrackingConfig is the value of the tracker key: a provider-discriminated mapping that selects the issue-tracker provider and holds its settings. At most one provider mapping may be set; the one that is set is the selected provider. A nil TrackingConfig, or one with no provider mapping, selects no provider and allows no issue destinations beyond the source repository.

func DefaultIssueTracking added in v0.55.0

func DefaultIssueTracking(forge string) *TrackingConfig

DefaultIssueTracking returns the tracker configuration a fresh installation without a preset records for the given forge: the upstream repositories on GitHub, and an explicit empty allowed_targets on GitLab, where GitHub upstream names are not destinations. Any other forge gets nil.

func (*TrackingConfig) Provider added in v0.55.0

func (t *TrackingConfig) Provider() string

Provider returns the selected provider name (TrackingProviderGitHub, TrackingProviderGitLab, or TrackingProviderJira), or "" when no provider mapping is set. It also returns "" when more than one mapping is set: runtime loading does not run validateTracking, so an ambiguous mapping fails closed (selects no provider and grants nothing) instead of silently picking one.

func (*TrackingConfig) UnmarshalYAML added in v0.55.0

func (t *TrackingConfig) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler. The legacy scalar form (tracker: jira) is rejected with a migration message instead of a generic type error; a mapping decodes as usual.

type TrackingLayerKind added in v0.55.0

type TrackingLayerKind int

TrackingLayerKind classifies the issue-tracking keys one configuration layer declares.

const (
	// TrackingLayerUnset declares neither tracker nor create_issues.
	TrackingLayerUnset TrackingLayerKind = iota
	// TrackingLayerLegacy declares the scalar tracker form, the removed
	// create_issues block, or both.
	TrackingLayerLegacy
	// TrackingLayerMapping declares a provider-discriminated tracker
	// mapping.
	TrackingLayerMapping
)

type TrackingReader added in v0.55.0

type TrackingReader interface {
	IssueTracking() *TrackingConfig
}

TrackingReader provides read access to the issue-tracking configuration, including the selected provider's cross-project allowed_targets.

Jump to

Keyboard shortcuts

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