config

package

Go to main page

Versions in this module

v0

v0.6.1

Jun 5, 2026

Changes in this version

type NarratorItem

+ Build string

v0.6.0

Jun 4, 2026

Changes in this version

+ func DeepMerge(base, override map[string]any) map[string]any

+ func LoadWithReport(path string) (*Config, ConfigReport, error)

+ func PrimaryDefaultBranch(cfg *Config) string

+ func PrimaryURL(cfg *Config) string

+ func PrimaryWorktree(cfg *Config) string

+ func ValidateIdentityGraph(forges []ForgeConfig, repos []RepoConfig, registries []RegistryConfig) []string

+ func ValidatePreset(content []byte) (string, map[string]any, error)

+ func ValidateTargetRegistryRefs(targets []TargetConfig, registries []RegistryConfig) []string

type BadgesConfig

+ Preset string

+ type BranchBuildConfig struct

+ BaseFrom []string

+ Format string

+ ID string

+ Match string

+ type BranchesConfig struct

+ Default string

type BuildCacheConfig

+ Preset string

+ type CIConfig struct

+ Image string

+ Routing RoutingConfig

type CommitConfig

+ Preset string

type Config

+ CI CIConfig

+ Forges []ForgeConfig

+ Matchers MatchersConfig

+ Registries []RegistryConfig

+ Repos []RepoConfig

+ Toolchains ToolchainConfig

+ Versioning VersioningConfig

+ type ConfigReport struct

+ Completeness string

+ Error string

+ Overrides int

+ Presets []string

+ Sections []SectionState

+ SourceFile string

+ Status string

+ VarsApplied int

+ Warnings []string

type DependencyCommitConfig

+ RunFrom RunFromConfig

type DependencyConfig

+ Preset string

type DockerLifecycleConfig

+ Preset string

type DocsCommitConfig

+ RunFrom RunFromConfig

type DocsConfig

+ Preset string

+ type ForgeConfig struct

+ Credentials string

+ ID string

+ Provider string

+ URL string

+ func FindForgeByID(forges []ForgeConfig, id string) *ForgeConfig

type GitOpsConfig

+ Preset string

type GlossaryConfig

+ Preset string

type GovernanceClusterTargets

+ Credentials string

type LifecycleConfig

+ Preset string

type LintConfig

+ Preset string

type ManifestConfig

+ Preset string

+ type MatchersConfig struct

+ Branches map[string]string

+ Preset string

+ func DefaultMatchersConfig() MatchersConfig

+ type MergeEntry struct

+ Layer int

+ Operation string

+ Overridden bool

+ OverriddenBy string

+ Path string

+ Source string

+ SourceRef string

+ Value any

+ func ResolvePresets(raw map[string]any, loader PresetLoader, sourceRef, sourcePath string, ...) (map[string]any, []MergeEntry, error)

+ type MergeTrace struct

+ Entries []MergeEntry

+ type NoLineageConfig struct

+ Mode string

+ Version string

type PresentationConfig

+ Preset string

+ type PresetLoader interface

+ Load func(path string) ([]byte, error)

+ type RegistryConfig struct

+ Credentials string

+ DefaultPath string

+ ID string

+ Provider string

+ URL string

+ func FindRegistryByID(registries []RegistryConfig, id string) *RegistryConfig

type ReleaseConfig

+ Preset string

+ RunFrom RunFromConfig

+ type RepoConfig struct

+ Branches BranchesConfig

+ Forge string

+ ID string

+ Project string

+ Ref string

+ Roles []string

+ Sync SyncConfig

+ Worktree string

+ func FindRepoByID(repos []RepoConfig, id string) *RepoConfig

+ func FindRepoWithRole(repos []RepoConfig, role string) *RepoConfig

+ func MirrorRepos(repos []RepoConfig) []RepoConfig

+ func (r RepoConfig) HasRole(role string) bool

+ type ResolvedRegistry struct

+ Credentials string

+ ID string

+ Path string

+ Provider string

+ URL string

+ func ResolveRegistryForTarget(target TargetConfig, registries []RegistryConfig, vars map[string]string) (*ResolvedRegistry, error)

+ type ResolvedRepo struct

+ BaseURL string

+ Credentials string

+ DefaultBranch string

+ ID string

+ Project string

+ Provider string

+ Ref string

+ Roles []string

+ Sync SyncConfig

+ Worktree string

+ func ResolveAllMirrors(repos []RepoConfig, forges []ForgeConfig, vars map[string]string) ([]*ResolvedRepo, error)

+ func ResolvePrimary(repos []RepoConfig, forges []ForgeConfig, vars map[string]string) (*ResolvedRepo, error)

+ func ResolveRepo(repo RepoConfig, forges []ForgeConfig, vars map[string]string) (*ResolvedRepo, error)

+ func (r ResolvedRepo) HasRole(role string) bool

+ type RoutingConfig struct

+ Perform RoutingSpec

+ type RoutingSpec struct

+ Labels []string

+ type RunFromConfig struct

+ Allow []string

+ Mismatch string

+ func (rf RunFromConfig) IsActive() bool

+ type RunFromResult struct

+ Matched bool

+ Mode string

+ Reason string

+ func EvaluateRunFrom(rf RunFromConfig, ciRepoURL, primaryURL string) RunFromResult

+ type SectionState struct

+ Active bool

+ Kind string

+ Name string

+ Provenance string

+ ResolutionStatus string

+ SourcePresent bool

type SecurityConfig

+ Preset string

type TagConfig

+ Preset string

+ type TagSourceConfig struct

+ ID string

+ Pattern string

type TargetConfig

+ Mirror string

+ Registry string

+ RunFrom RunFromConfig

+ type ToolPinConfig struct

+ Version string

+ type ToolchainConfig struct

+ Desired map[string]ToolPinConfig

+ type VersioningConfig struct

+ BranchBuilds []BranchBuildConfig

+ NoLineage NoLineageConfig

+ Preset string

+ TagSources []TagSourceConfig

+ func DefaultVersioningConfig() VersioningConfig

v0.5.0

Apr 4, 2026

Changes in this version

+ func AssertNormalized(cfg *Config) error

+ func ForgeLinkBase(provider, baseURL, projectID, branch string) (string, error)

+ func ForgeRawBase(provider, baseURL, projectID, branch string) (string, error)

+ func Normalize(cfg *Config) error

+ func ParseDuration(s string) (time.Duration, error)

+ func ParseForgeURL(rawURL string) (provider, baseURL, projectID string, err error)

+ func ParseSize(s string) (int64, error)

+ func ResolveLinkBase(cfg *Config) (string, error)

+ func ResolvePublishOrigin(cfg *Config) (string, error)

+ type AgePruneRule struct

+ OlderThan string

+ type BadgeConfig struct

+ Color string

+ Font string

+ FontSize int

+ ID string

+ Link string

+ Output string

+ Text string

+ Value string

+ func (b BadgeConfig) ToBadgeSpec() BadgeSpec

+ type BadgesConfig struct

+ Items []BadgeConfig

+ type BreakingConfig struct

+ Aliases []string

+ BangSuffix bool

+ FooterKeys []string

+ ForceHighlight bool

+ PriorityBoost int

+ type BuildCacheConfig struct

+ Builder BuilderConfig

+ Cleanup HostCleanupConfig

+ External ExternalCacheConfig

+ Local LocalCacheConfig

+ Mode string

+ func DefaultBuildCacheConfig() BuildCacheConfig

+ func (c BuildCacheConfig) IsActive() bool

+ type BuildCachePrunePolicy struct

+ KeepStorage string

+ OlderThan string

type BuildConfig

+ Required *bool

+ func (b BuildConfig) IsRequired() bool

+ type BuilderConfig struct

+ Backend string

+ Context string

+ Driver string

+ Name string

+ func (b BuilderConfig) BuilderDriver() string

+ func (b BuilderConfig) BuilderName() string

+ func (b BuilderConfig) ContextName() string

+ type ClusterConfig struct

+ Exposure ExposureRules

+ Name string

+ Server string

+ type CommitPresentation struct

+ EnforceConventional bool

+ PreserveRawSubject bool

type Config

+ Badges BadgesConfig

+ BuildCache BuildCacheConfig

+ Docker DockerLifecycleConfig

+ GitOps GitOpsConfig

+ Glossary GlossaryConfig

+ Governance GovernanceConfig

+ Lifecycle LifecycleConfig

+ Presentation PresentationConfig

+ Tag TagConfig

+ type ContainerPrunePolicy struct

+ Exited AgePruneRule

+ type DockerDriftPolicy struct

+ OrphanAction string

+ OrphanThreshold int

+ PruneRequiresConfirmation bool

+ Tier2Action string

+ type DockerIaCConfig struct

+ Path string

+ type DockerLifecycleConfig struct

+ Backend string

+ Drift DockerDriftPolicy

+ IaC DockerIaCConfig

+ Secrets DockerSecretsConfig

+ Targets DockerTargetsConfig

+ func DefaultDockerLifecycleConfig() DockerLifecycleConfig

+ type DockerSecretsConfig struct

+ Provider string

+ type DockerTargetSelector struct

+ Groups []string

+ type DockerTargetsConfig struct

+ Inventory string

+ Selector DockerTargetSelector

+ Source string

+ type ExposureRule struct

+ CIDRs []string

+ Endpoints []string

+ Gateways []string

+ Level string

+ Ports []int

+ ServiceTypes []string

+ type ExposureRules struct

+ Rules []ExposureRule

+ type ExternalCacheConfig struct

+ Fallback string

+ Mode string

+ Path string

+ Retention ExternalRetention

+ Target string

+ type ExternalRetention struct

+ MaxRefs int

+ StaleAge string

+ type FilterConfig struct

+ NormalizeWhitespace bool

+ Summary SummaryFilter

+ Trailers TrailerFilter

+ type GitOpsConfig struct

+ Backend string

+ Cluster ClusterConfig

+ OIDC OIDCConfig

+ func DefaultGitOpsConfig() GitOpsConfig

+ type GlossaryConfig struct

+ Breaking BreakingConfig

+ Filters FilterConfig

+ Render RenderConfig

+ Rewrites RewriteConfig

+ Types map[string]GlossaryType

+ func DefaultGlossaryConfig() GlossaryConfig

+ type GlossaryType struct

+ Aliases []string

+ CanonicalAs string

+ Priority int

+ ReleaseVisible bool

+ type GovernanceCluster struct

+ ID string

+ StageFreight map[string]any

+ Targets GovernanceClusterTargets

+ type GovernanceClusterGroup struct

+ ID string

+ Repos []string

+ type GovernanceClusterTargets struct

+ Groups []GovernanceClusterGroup

+ Repos []string

+ type GovernanceConfig struct

+ Clusters []GovernanceCluster

+ type HostCleanupConfig struct

+ Enabled bool

+ Enforcement string

+ Protect ProtectionPolicy

+ Prune PrunePolicy

+ type ImageProtection struct

+ Refs []string

+ type ImagePrunePolicy struct

+ Dangling AgePruneRule

+ Unreferenced AgePruneRule

+ type LifecycleConfig struct

+ Mode string

+ type LintCacheConfig struct

+ MaxAge string

+ MaxSize string

type LintConfig

+ Cache LintCacheConfig

+ type LocalCacheConfig struct

+ Path string

+ Retention LocalRetention

+ type LocalRetention struct

+ MaxAge string

+ MaxSize string

type MirrorConfig

+ func FindMirrorByID(mirrors []MirrorConfig, id string) *MirrorConfig

type NarratorItem

+ CatalogPath string

+ Ref string

+ type NetworkPrunePolicy struct

+ Unused bool

+ type OIDCConfig struct

+ Audience string

+ type PhraseRewrite struct

+ From string

+ To string

+ type PresentationConfig struct

+ Commit CommitPresentation

+ Release ReleasePresentation

+ Tag TagPresentation

+ func DefaultPresentationConfig() PresentationConfig

+ type ProtectionPolicy struct

+ Images ImageProtection

+ Volumes VolumeProtection

+ type PrunePolicy struct

+ BuildCache BuildCachePrunePolicy

+ Containers ContainerPrunePolicy

+ Images ImagePrunePolicy

+ Networks NetworkPrunePolicy

+ type PublishOrigin struct

+ Base string

+ Kind string

+ Ref string

+ type RegexRewrite struct

+ Pattern string

+ Replace string

type ReleaseConfig

+ Required *bool

+ func (r ReleaseConfig) IsRequired() bool

+ type ReleasePresentation struct

+ GroupByType bool

+ IncludeReleaseVisibleOnly bool

+ MaxEntries int

+ Style string

+ type RenderConfig struct

+ EmptyStrategy string

+ type RewriteConfig struct

+ Phrases []PhraseRewrite

+ Regex []RegexRewrite

+ type ScannerCacheConfig struct

+ MaxAge string

+ MaxSize string

+ type SecurityCacheConfig struct

+ Grype ScannerCacheConfig

+ Trivy ScannerCacheConfig

type SecurityConfig

+ Cache SecurityCacheConfig

+ Required *bool

+ func (s SecurityConfig) IsRequired() bool

type SourcesConfig

+ PublishOrigin *PublishOrigin

+ type SummaryFilter struct

+ StripPhrases []string

+ StripRegex []string

+ type TagConfig struct

+ Defaults TagDefaults

+ Message TagMessage

+ func DefaultTagConfig() TagConfig

+ type TagDefaults struct

+ Preview bool

+ Push bool

+ RequireApproval bool

+ Target string

+ type TagMessage struct

+ EmptyStrategy string

+ Mode string

+ type TagPresentation struct

+ CollapseSimilar bool

+ GroupByType bool

+ IncludeReleaseVisibleOnly bool

+ MaxEntries int

+ Style string

+ type TrailerFilter struct

+ StripKeys []string

+ type VolumeProtection struct

+ Named *bool

v0.4.1

Mar 27, 2026

Changes in this version

+ type MirrorConfig struct

+ Credentials string

+ ID string

+ ProjectID string

+ Provider string

+ Sync SyncConfig

+ URL string

type NarratorItem

+ Summary string

+ Wrap string

type SourcesConfig

+ Mirrors []MirrorConfig

+ type SyncConfig struct

+ Docs bool

+ Git bool

+ Releases bool

v0.4.0

Mar 22, 2026

Changes in this version

type BuildConfig

+ Args []string

+ Builder string

+ Command string

+ Compress bool

+ Crucible *CrucibleConfig

+ DependsOn string

+ Env map[string]string

+ From string

+ Output string

+ func (b BuildConfig) BuilderCommand() string

+ func (b BuildConfig) OutputName() string

+ type CrucibleConfig struct

+ ToolchainImage string

type DependencyCommitConfig

+ MR DependencyMRConfig

+ Promotion DependencyCommitPromotion

+ type DependencyCommitPromotion string

+ const PromotionDirect

+ const PromotionMR

+ type DependencyMRConfig struct

+ BranchPrefix string

+ TargetBranch string

type TargetConfig

+ Archives string

+ BinaryName string

+ Checksums bool

+ Format string

+ Include []string

+ Name string

+ NativeScan bool

v0.3.2

Mar 16, 2026

Changes in this version

type Config

+ Manifest ManifestConfig

+ type ManifestConfig struct

+ Enabled bool

+ Mode string

+ OutputDir string

+ func DefaultManifestConfig() ManifestConfig

type NarratorItem

+ Columns []string

+ OutputFile string

+ Renderer string

+ Section string

+ Source string

v0.3.1

Mar 13, 2026

v0.3.0

Mar 13, 2026

Changes in this version

+ func MatchCondition(c Condition) bool

+ func MatchConditionWith(c Condition, tag, branch string) bool

+ func MatchPatterns(patterns []string, value string) bool

+ func MatchPatternsWithPolicy(patterns []string, value string, policyMap map[string]string) bool

+ func MigrateToLatest(data []byte) ([]byte, error)

+ func ResolvePatterns(patterns []string, policyMap map[string]string) []string

+ func Validate(cfg *Config) (warnings []string, err error)

+ type BadgeSpec struct

+ Color string

+ Font string

+ FontFile string

+ FontSize float64

+ Label string

+ Output string

+ Value string

+ type BuildConfig struct

+ BuildArgs map[string]string

+ BuildMode string

+ Cache CacheConfig

+ Context string

+ Dockerfile string

+ ID string

+ Kind string

+ Platforms []string

+ SelectTags []string

+ Target string

+ type CacheConfig struct

+ AutoDetect *bool

+ Watch []WatchRule

+ type CommitConfig struct

+ Backend string

+ Conventional bool

+ DefaultScope string

+ DefaultType string

+ Push bool

+ SkipCI bool

+ Types []CommitType

+ func DefaultCommitConfig() CommitConfig

+ type CommitType struct

+ AliasFor string

+ ForceBang bool

+ Key string

+ Label string

+ type CompiledPatterns struct

+ Exclude []*regexp.Regexp

+ Include []*regexp.Regexp

+ func CompilePatterns(patterns []string, policyMap map[string]string) (*CompiledPatterns, error)

+ func CompilePatternsWithWarnings(patterns []string, policyMap map[string]string) (*CompiledPatterns, []string, error)

+ func (cp *CompiledPatterns) Match(value string) bool

+ type Condition struct

+ Branch string

+ Tag string

+ type Config struct

+ Builds []BuildConfig

+ Commit CommitConfig

+ Defaults yaml.Node

+ Dependency DependencyConfig

+ Docs DocsConfig

+ Lint LintConfig

+ Narrator []NarratorFile

+ Policies PoliciesConfig

+ Release ReleaseConfig

+ Security SecurityConfig

+ Sources SourcesConfig

+ Targets []TargetConfig

+ Vars map[string]string

+ Version int

+ func Load(path string) (*Config, error)

+ func LoadWithWarnings(path string) (*Config, []string, error)

+ type DependencyCIConfig struct

+ Handoff DependencyHandoff

+ type DependencyCommitConfig struct

+ Enabled bool

+ Message string

+ Push bool

+ SkipCI bool

+ Type string

+ type DependencyConfig struct

+ CI DependencyCIConfig

+ Commit DependencyCommitConfig

+ Enabled bool

+ Output string

+ Scope DependencyScopeConfig

+ func DefaultDependencyConfig() DependencyConfig

+ type DependencyHandoff string

+ const HandoffContinue

+ const HandoffFail

+ const HandoffRestartPipeline

+ type DependencyScopeConfig struct

+ DockerfileEnv bool

+ GoModules bool

+ func (s DependencyScopeConfig) ScopeToEcosystems() []string

+ type DetailRule struct

+ Detail string

+ type DocsCommitConfig struct

+ Add []string

+ Enabled bool

+ Message string

+ Push bool

+ SkipCI bool

+ Type string

+ type DocsConfig struct

+ Commit DocsCommitConfig

+ Enabled bool

+ Generators DocsGeneratorsConfig

+ func DefaultDocsConfig() DocsConfig

+ type DocsGeneratorsConfig struct

+ Badges bool

+ DockerReadme bool

+ Narrator bool

+ ReferenceDocs bool

+ type Level string

+ const LevelChanged

+ const LevelFull

+ type LintConfig struct

+ CacheDir string

+ Exclude []string

+ Level Level

+ Modules map[string]ModuleConfig

+ TargetBranch string

+ func DefaultLintConfig() LintConfig

+ type ModuleConfig struct

+ Enabled *bool

+ Exclude []string

+ Options map[string]any

+ type NarratorFile struct

+ File string

+ Items []NarratorItem

+ LinkBase string

+ type NarratorItem struct

+ Color string

+ Content string

+ Font string

+ FontSize int

+ ID string

+ Kind string

+ Label string

+ Link string

+ Logo string

+ Output string

+ Params map[string]string

+ Path string

+ Placement NarratorPlacement

+ Shield string

+ Spec string

+ Style string

+ Text string

+ Type string

+ Value string

+ func (n NarratorItem) HasGeneration() bool

+ func (n NarratorItem) ToBadgeSpec() BadgeSpec

+ type NarratorPlacement struct

+ After string

+ Before string

+ Between [2]string

+ Heading string

+ Inline bool

+ Mode string

+ type PoliciesConfig struct

+ Branches map[string]string

+ GitTags map[string]string

+ func DefaultPoliciesConfig() PoliciesConfig

+ type ReleaseConfig struct

+ CatalogLinks bool

+ Enabled bool

+ RegistryLinks bool

+ SecuritySummary string

+ func DefaultReleaseConfig() ReleaseConfig

+ type RetentionPolicy struct

+ KeepDaily int

+ KeepLast int

+ KeepMonthly int

+ KeepWeekly int

+ KeepYearly int

+ Protect []string

+ func (r *RetentionPolicy) UnmarshalYAML(value *yaml.Node) error

+ func (r RetentionPolicy) Active() bool

+ type ScannersConfig struct

+ Grype *bool

+ Trivy *bool

+ func (s ScannersConfig) GrypeEnabled() bool

+ func (s ScannersConfig) TrivyEnabled() bool

+ type SecurityConfig struct

+ Enabled bool

+ FailOnCritical bool

+ OutputDir string

+ OverwhelmLink string

+ OverwhelmMessage []string

+ ReleaseDetail string

+ ReleaseDetailRules []DetailRule

+ SBOMEnabled bool

+ Scanners ScannersConfig

+ func DefaultSecurityConfig() SecurityConfig

+ type SourceConfig struct

+ DefaultBranch string

+ Kind string

+ URL string

+ Worktree string

+ type SourcesConfig struct

+ Primary SourceConfig

+ func DefaultSourcesConfig() SourcesConfig

+ type TargetCondition struct

+ Branches []string

+ Events []string

+ GitTags []string

+ type TargetConfig struct

+ Aliases []string

+ Build string

+ Catalog bool

+ Credentials string

+ Description string

+ File string

+ ID string

+ Kind string

+ LinkBase string

+ Path string

+ ProjectID string

+ Provider string

+ Retention *RetentionPolicy

+ SelectTags []string

+ SpecFiles []string

+ SyncAssets bool

+ SyncRelease bool

+ Tags []string

+ URL string

+ When TargetCondition

+ func (t TargetConfig) IsRemoteRelease() bool

+ type WatchRule struct

+ Invalidates []string

+ Paths []string

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