config

package

Go to main page

Versions in this module

v0

v0.9.1

Oct 8, 2026

Changes in this version

+ const PrepareProfileCargoWorkspaceV1

+ const PrepareProfilePnpmFrozenLockfileV1

+ func ValidateMakeOutcomeReport(r MakeOutcomeReport) error

type BranchConfig

+ MakeOutcomeReport *MakeOutcomeReport

+ type FlatRepo struct

+ AdditionalRemotes map[string]string

+ AssumePresent bool

+ Branch FlexBranch

+ Description string

+ Enabled *bool

+ Name string

+ Path string

+ Provider string

+ Strategy string

+ StrictBranchCheckout *bool

+ URL string

+ type FlatRepositories struct

+ Branch FlexBranch

+ CleanupOrphans *bool

+ DryRun bool

+ Kind ConfigKind

+ MaxRetries *int

+ Metadata *Metadata

+ Parallel *int

+ Repositories []FlatRepo

+ Resume bool

+ Roots []string

+ Strategy string

+ StrictBranchCheckout bool

+ Version int

+ func ParseFlatRepositories(data []byte) (FlatRepositories, error)

+ type MakeOutcomeReport struct

+ Targets []string

+ Version int

+ func ParseMakeOutcomeReportDocument(data []byte, isJSON bool) (*MakeOutcomeReport, error)

+ func (r *MakeOutcomeReport) Includes(target string) bool

type TaskPatternDecl

+ MakeOutcomeReport *MakeOutcomeReport

v0.9.0

Oct 2, 2026

Changes in this version

type BranchConfig

+ MakeTimeout string

type TaskPatternDecl

+ MakeTimeout time.Duration

v0.8.0

Oct 1, 2026

Changes in this version

+ const ActiveProfileFileName

+ const AutoGeneratedMarker

+ const ConfigDirName

+ const DefaultConfigFileName

+ const DefaultProfileName

+ const ExampleConfig

+ const GlobalConfigFileName

+ const IntegrationBranchSourceConfigPrefix

+ const IntegrationBranchSourceHeuristic

+ const IntegrationBranchSourceNone

+ const MaxConfigDepth

+ const PrepareProfileFamilybookEntV1

+ const PrepareProfileFlowTaskchainLocalSubprojectsV1

+ const ProfilesDirName

+ const ProjectConfigFileName

+ const StateDirName

+ var ErrKeyringUnavailable = fmt.Errorf("keyring unavailable")

+ func CanonicalReadiness(r Readiness) (string, error)

+ func ClearWorkspaceAccessMarker(ctx context.Context, repoPath string) error

+ func CreateConfigSymlink(srcPath, targetDir, parentConfigDir string) error

+ func CreateConfigSymlinkForce(srcPath, targetDir, parentConfigDir string) error

+ func DetectAllConfigFiles(dir string) []string

+ func DetectConfigFile(dir string) (string, error)

+ func FindConfigRecursive(startPath, configFile string) (string, error)

+ func FindProjectConfig() (string, error)

+ func GetAllProfiles(config *Config) map[string]*Profile

+ func GetAllWorkspaces(config *Config) []struct

+ func GetConfigWorkspaces(config *Config) map[string]*Workspace

+ func GetForgeWorkspaces(config *Config) map[string]*Workspace

+ func GetGitWorkspaces(config *Config) map[string]*Workspace

+ func GetProfileSource(config *Config, name string) string

+ func GetSymlinkTarget(linkPath string) (string, error)

+ func HasInlineProfile(config *Config, name string) bool

+ func IsConfigSymlink(configPath string) (bool, error)

+ func IsValidBaseURL(s string) bool

+ func IsValidCloneProto(proto string) bool

+ func IsValidProfileName(name string) bool

+ func IsValidProvider(provider string) bool

+ func IsValidSyncStrategy(strategy string) bool

+ func LoadWorkspaces(path string, config *Config, mode DiscoveryMode) error

+ func MatchTaskPattern(name, pattern string) bool

+ func MatchesAnyTaskPattern(name string, patterns []string) bool

+ func NormalizeIntegrationBranchName(raw string, remotes []string) string

+ func NormalizeName(raw string, remotes []string) string

+ func NormalizeProvider(provider string) string

+ func ParsePrepareProfileDocument(data []byte, isJSON bool) (profile string, present bool, err error)

+ func ReadinessDigest(r Readiness) (string, error)

+ func RecordWorkspaceReadOnly(ctx context.Context, repoPath string) error

+ func RejectMultiDocumentYAML(data []byte) error

+ func ResolveDeclaredIntegrationBranch(ctx context.Context, repoPath string) (string, error)

+ func ResolveTokenFromEnv(provider string) (token, source string)

+ func SanitizeToken(s string) string

+ func SetTokenStore(s TokenStore)

+ func SplitIntegrationRemoteBranch(raw string, remotes []string) (remote, branch string, ok bool)

+ func SplitRemoteBranch(raw string, remotes []string) (remote, branch string, ok bool)

+ func UpstreamTargetsIntegration(branch, upstream string, resolution Resolution, remotes []string) bool

+ func UpstreamTargetsIntegrationBranch(branch, upstream string, resolution IntegrationBranchResolution, ...) bool

+ func ValidatePrepareProfile(profile string) error

+ func ValidateReadiness(r Readiness) error

+ type AuditConfig struct

+ Autofix map[string]bool

+ type BranchConfig struct

+ DefaultBranch BranchList

+ IntegrationBranch BranchList

+ Naming *branch.Naming

+ PrepareProfile string

+ ProtectedBranches []string

+ Readiness *Readiness

+ TaskPattern BranchList

+ func (b *BranchConfig) UnmarshalYAML(unmarshal func(any) error) error

+ type BranchList []string

+ func (b *BranchList) UnmarshalYAML(unmarshal func(any) error) error

+ func (b BranchList) First() string

+ func (b BranchList) MarshalYAML() (any, error)

+ func (b BranchList) String() string

+ type ChildConfigFormat string

+ const ChildConfigFormatAutoGenerated

+ const ChildConfigFormatNotFound

+ const ChildConfigFormatUserMaintained

+ func DetectChildConfigFormat(path string) (ChildConfigFormat, error)

+ type ChildConfigMode string

+ const ChildConfigModeNone

+ const ChildConfigModeRepositories

+ const ChildConfigModeWorkspaces

+ func (m ChildConfigMode) Default() ChildConfigMode

+ func (m ChildConfigMode) IsValid() bool

+ type CloneDefaults struct

+ Proto string

+ SSHKeyContent string

+ SSHKeyPath string

+ SSHPort int

+ type Config struct

+ BaseURL string

+ Branch *BranchConfig

+ ChildConfigMode ChildConfigMode

+ ConfigPath string

+ DefaultWorkspaceType WorkspaceType

+ Defaults *DefaultsConfig

+ Discovery *DiscoveryConfig

+ Fetch *FetchConfig

+ Hooks *Hooks

+ IncludeSubgroups bool

+ Metadata *Metadata

+ Parent string

+ ParentConfig *Config

+ Profile string

+ Profiles map[string]*Profile

+ Provider string

+ Pull *PullConfig

+ Push *PushConfig

+ SelfSync *SelfSyncConfig

+ SubgroupMode string

+ Sync *SyncConfig

+ Token string

+ Workspaces map[string]*Workspace

+ func GetParentChain(config *Config) []*Config

+ func LoadConfigRecursive(path, configFile string) (*Config, error)

+ func (c *Config) GetCloneProto() string

+ func (c *Config) GetCompactOutput() bool

+ func (c *Config) GetExcludePatterns() []string

+ func (c *Config) GetFormat() string

+ func (c *Config) GetIncludePatterns() []string

+ func (c *Config) GetMaxRetries() int

+ func (c *Config) GetParallel() int

+ func (c *Config) GetSSHKeyContent() string

+ func (c *Config) GetSSHKeyPath() string

+ func (c *Config) GetSSHPort() int

+ func (c *Config) GetScanDepth() int

+ func (c *Config) GetScanExcludePatterns() []string

+ func (c *Config) GetSyncStrategy() string

+ func (c *Config) GetTimeout() string

+ type ConfigFileInfo struct

+ Kind ConfigKind

+ Path string

+ type ConfigKind string

+ const KindRepositories

+ const KindWorkspace

+ func DetectConfigFileWithKind(dir string) (string, ConfigKind)

+ func (k ConfigKind) IsValid() bool

+ type ConfigLoader struct

+ func NewLoader() (*ConfigLoader, error)

+ func (l *ConfigLoader) Load() error

+ func (l *ConfigLoader) ResolveConfig(flags map[string]any) (*EffectiveConfig, error)

+ func (l *ConfigLoader) SetActiveProfileInternal(profile *Profile)

+ type ConfigMeta struct

+ Kind ConfigKind

+ Metadata *Metadata

+ Version int

+ type ConfigSource string

+ const SourceDefault

+ const SourceEnv

+ const SourceFlag

+ const SourceGlobal

+ const SourceKeychain

+ const SourceProfile

+ const SourceProject

+ func (s ConfigSource) String() string

+ type ControllerConfig struct

+ Digest string

+ Path string

+ Workspaces map[string]*Workspace

+ func LoadControllerConfig(path string) (*ControllerConfig, error)

+ type DefaultsConfig struct

+ Clone *CloneDefaults

+ Filter *FilterDefaults

+ Output *OutputDefaults

+ Scan *ScanDefaults

+ Sync *SyncDefaults

+ type DiscoveryConfig struct

+ Mode DiscoveryMode

+ type DiscoveryMode string

+ const AutoMode

+ const ExplicitMode

+ const HybridMode

+ func (m DiscoveryMode) Default() DiscoveryMode

+ func (m DiscoveryMode) IsValid() bool

+ type EffectiveConfig struct

+ Audit AuditConfig

+ BaseURL string

+ Branch BranchConfig

+ CloneProto string

+ Fetch FetchConfig

+ Identity identity.Identity

+ IncludeSubgroups bool

+ Parallel int

+ Provider string

+ Pull PullConfig

+ Push PushConfig

+ SSHKeyContent string

+ SSHKeyPath string

+ SSHPort int

+ Sources map[string]string

+ SubgroupMode string

+ Sync SyncConfig

+ Token string

+ func (cfg *EffectiveConfig) GetBool(key string) (value, ok bool)

+ func (cfg *EffectiveConfig) GetInt(key string) (int, bool)

+ func (cfg *EffectiveConfig) GetSource(key string) string

+ func (cfg *EffectiveConfig) GetString(key string) (string, bool)

+ type Environment struct

+ GitHubToken string

+ GitLabToken string

+ GiteaToken string

+ type Facts = IntegrationBranchFacts

+ type FetchConfig struct

+ AllRemotes bool

+ Prune bool

+ type FilterDefaults struct

+ Exclude []string

+ Include []string

+ type FlexBranch string

+ func (f *FlexBranch) UnmarshalYAML(unmarshal func(any) error) error

+ func (f FlexBranch) MarshalYAML() (any, error)

+ func (f FlexBranch) String() string

+ type ForgeSource struct

+ BaseURL string

+ IncludeSubgroups bool

+ Org string

+ Provider string

+ SubgroupMode string

+ Token string

+ type GlobalConfig struct

+ ActiveProfile string

+ Defaults map[string]any

+ Environments map[string]Environment

+ Identity *identity.Identity

+ type Hooks struct

+ After []string

+ Before []string

+ type IntegrationBranchFacts struct

+ Config []string

+ DefaultName string

+ Refs []string

+ Remotes []string

+ type IntegrationBranchResolution struct

+ Name string

+ Participates bool

+ Source string

+ func ResolveIntegrationBranch(ctx context.Context, exec *gitcmd.Executor, repoPath string, ...) (IntegrationBranchResolution, error)

+ func ResolveIntegrationBranchFromFacts(f IntegrationBranchFacts) IntegrationBranchResolution

+ type IntegrationControl struct

+ PrepareProfile string

+ type IntegrationParticipationAction string

+ const IntegrationParticipationConflict

+ const IntegrationParticipationInstall

+ const IntegrationParticipationNoop

+ const IntegrationParticipationRemove

+ const IntegrationParticipationUpdate

+ func PlanIntegrationParticipation(state IntegrationParticipationState) IntegrationParticipationAction

+ func ReconcileIntegrationParticipation(ctx context.Context, repoPath string) (IntegrationParticipationAction, error)

+ type IntegrationParticipationState struct

+ Current string

+ Desired string

+ Marker string

+ type KeyringTokenStore struct

+ func (s *KeyringTokenStore) Available() bool

+ func (s *KeyringTokenStore) Delete(provider string) error

+ func (s *KeyringTokenStore) Get(provider string) (string, error)

+ func (s *KeyringTokenStore) Set(provider, token string) error

+ type Manager struct

+ func NewManager() (*Manager, error)

+ func (m *Manager) CreateProfile(profile *Profile) error

+ func (m *Manager) DeleteProfile(name string) error

+ func (m *Manager) FindNearestConfig(configFile string) (string, error)

+ func (m *Manager) GetActiveProfile() (string, error)

+ func (m *Manager) Initialize() error

+ func (m *Manager) ListProfiles() ([]string, error)

+ func (m *Manager) LoadConfigRecursiveFromPath(path, configFile string) (*Config, error)

+ func (m *Manager) LoadGlobalConfig() (*GlobalConfig, error)

+ func (m *Manager) LoadProfile(name string) (*Profile, error)

+ func (m *Manager) LoadProjectConfig() (*ProjectConfig, error)

+ func (m *Manager) ProfileExists(name string) bool

+ func (m *Manager) SaveConfig(path, configFile string, config *Config) error

+ func (m *Manager) SaveGlobalConfig(config *GlobalConfig) error

+ func (m *Manager) SaveProfile(profile *Profile) error

+ func (m *Manager) SaveProjectConfig(config *ProjectConfig) error

+ func (m *Manager) SetActiveProfile(name string) error

+ type MemoryTokenStore struct

+ func NewMemoryTokenStore() *MemoryTokenStore

+ func (m *MemoryTokenStore) Available() bool

+ func (m *MemoryTokenStore) Delete(provider string) error

+ func (m *MemoryTokenStore) Get(provider string) (string, error)

+ func (m *MemoryTokenStore) Set(provider, token string) error

+ func (m *MemoryTokenStore) SetAvailable(v bool)

+ type Metadata struct

+ Name string

+ Owner string

+ Repository string

+ Team string

+ Type string

+ type OutputDefaults struct

+ Compact bool

+ Format string

+ type Paths struct

+ ActiveProfileFile string

+ ConfigDir string

+ GlobalConfigFile string

+ ProfilesDir string

+ StateDir string

+ func NewPaths() (*Paths, error)

+ func (p *Paths) EnsureDirectories() error

+ func (p *Paths) Exists() bool

+ func (p *Paths) GetActiveProfile() (string, error)

+ func (p *Paths) ListProfiles() ([]string, error)

+ func (p *Paths) ProfileExists(name string) bool

+ func (p *Paths) ProfilePath(name string) string

+ func (p *Paths) SetActiveProfile(name string) error

+ type Profile struct

+ Audit *AuditConfig

+ BaseURL string

+ Branch *BranchConfig

+ CloneProto string

+ Fetch *FetchConfig

+ Identity *identity.Identity

+ IncludeSubgroups bool

+ Name string

+ Parallel int

+ Provider string

+ Pull *PullConfig

+ Push *PushConfig

+ SSHKeyContent string

+ SSHKeyPath string

+ SSHPort int

+ SubgroupMode string

+ Sync *SyncConfig

+ Token string

+ func GetProfileByName(config *Config, name string) *Profile

+ func GetProfileFromChain(config *Config, name string) *Profile

+ type ProjectConfig struct

+ Audit *AuditConfig

+ Branch *BranchConfig

+ Fetch *FetchConfig

+ Metadata *ProjectMetadata

+ Profile string

+ Pull *PullConfig

+ Push *PushConfig

+ Sync *SyncConfig

+ type ProjectMetadata struct

+ Owner string

+ Repository string

+ Team string

+ type PullConfig struct

+ FFOnly bool

+ Rebase bool

+ type PushConfig struct

+ Policy *repository.PushPolicy

+ SetUpstream bool

+ type Readiness struct

+ Runner string

+ Version int

+ func ParseReadinessDocument(data []byte, isJSON bool) (Readiness, bool, error)

+ type Resolution = IntegrationBranchResolution

+ func ResolveFromFacts(f Facts) Resolution

+ type ScanDefaults struct

+ Depth int

+ Exclude []string

+ type SelfSyncConfig struct

+ Enabled bool

+ Strategy string

+ type SyncConfig struct

+ CleanupOrphans bool

+ MaxRetries int

+ Recursive bool

+ Strategy string

+ Timeout string

+ type SyncDefaults struct

+ MaxRetries int

+ Parallel int

+ Strategy string

+ Timeout string

+ type TaskPatternDecl struct

+ Facts []string

+ IntegrationBranch BranchList

+ Patterns []string

+ Source string

+ func LoadRepoRootTaskPattern(repoRoot string) (TaskPatternDecl, error)

+ type TokenStore interface

+ Available func() bool

+ Delete func(provider string) error

+ Get func(provider string) (string, error)

+ Set func(provider, token string) error

+ var DefaultTokenStore TokenStore = &KeyringTokenStore{}

+ type Validator struct

+ ExpandEnvVars bool

+ func NewValidator() *Validator

+ func (v *Validator) ExpandEnvVarsInConfig(c *Config) error

+ func (v *Validator) ExpandEnvVarsInGlobalConfig(g *GlobalConfig) error

+ func (v *Validator) ExpandEnvVarsInProfile(p *Profile) error

+ func (v *Validator) ExpandEnvVarsInWorkspace(ws *Workspace) error

+ func (v *Validator) ValidateChildConfigMode(mode ChildConfigMode) error

+ func (v *Validator) ValidateConfig(c *Config) error

+ func (v *Validator) ValidateConfigLink(path string) error

+ func (v *Validator) ValidateDiscoveryConfig(d *DiscoveryConfig) error

+ func (v *Validator) ValidateForgeSource(s *ForgeSource) error

+ func (v *Validator) ValidateGlobalConfig(g *GlobalConfig) error

+ func (v *Validator) ValidateHooks(hooks *Hooks) error

+ func (v *Validator) ValidateParentPath(path string) error

+ func (v *Validator) ValidateProfile(p *Profile) error

+ func (v *Validator) ValidateProjectConfig(p *ProjectConfig) error

+ func (v *Validator) ValidateSyncConfig(s *SyncConfig) error

+ func (v *Validator) ValidateWorkspace(ws *Workspace, name string) error

+ type Workspace struct

+ Access WorkspaceAccess

+ AdditionalRemotes map[string]string

+ Branch *BranchConfig

+ ChildConfigMode ChildConfigMode

+ CloneProto string

+ ConfigLink string

+ ExcludePatterns []string

+ Fetch *FetchConfig

+ Hooks *Hooks

+ IncludePatterns []string

+ Integration *IntegrationControl

+ Metadata *Metadata

+ Parallel int

+ Path string

+ Profile string

+ Pull *PullConfig

+ Push *PushConfig

+ SSHKeyContent string

+ SSHKeyPath string

+ SSHPort int

+ Source *ForgeSource

+ Sync *SyncConfig

+ Type WorkspaceType

+ URL string

+ Workspaces map[string]*Workspace

+ func GetWorkspaceByName(config *Config, name string) *Workspace

+ type WorkspaceAccess string

+ const WorkspaceAccessReadOnly

+ const WorkspaceAccessReadWrite

+ func WorkspacePushAccess(repoPath string) (WorkspaceAccess, string, error)

+ func WorkspacePushAccessContext(ctx context.Context, repoPath string) (WorkspaceAccess, string, error)

+ func (a WorkspaceAccess) IsReadOnly() bool

+ func (a WorkspaceAccess) IsValid() bool

+ type WorkspaceType string

+ const WorkspaceTypeConfig

+ const WorkspaceTypeForge

+ const WorkspaceTypeGit

+ func (t WorkspaceType) IsValid() bool

+ func (t WorkspaceType) Resolve(hasSource bool) WorkspaceType

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