projectconfig

package

Go to main page

Versions in this module

v0

v0.3.0

Aug 11, 2026

Changes in this version

+ var ErrInvalidGitRef = errors.New("invalid git ref")

type ComponentBuildConfig

+ EmitUpstreamProvenance bool

+ func (c ComponentBuildConfig) HashInclude(field string, _ any) (bool, error)

type ComponentConfig

+ func (c *ComponentConfig) ValidateArchiveOverlays(allowMissingOrigins bool) error

type ComponentOverlay

+ func (c *ComponentOverlay) TargetsLooseFile(filename string) (bool, error)

+ type GitSourceConfig struct

+ GitURL string

+ Ref string

+ func (g *GitSourceConfig) Validate(context string) error

+ type LisaConfig struct

+ ExtraArgs []string

+ Framework GitSourceConfig

+ PipExtras []string

+ PipPreInstall []string

+ TestCases []string

type OriginType

+ const OriginTypeOverlay

+ func (t OriginType) IsFetched() bool

type TestSuiteConfig

+ Lisa *LisaConfig

v0.2.0

Jul 16, 2026

Changes in this version

+ const DefaultLockDir

+ const DefaultLogDir

+ const DefaultOutputDir

+ const DefaultRenderedSpecsDir

+ const DefaultWorkDir

+ const UseCaseImageBuild

+ const UseCaseRPMBuild

+ const UserConfigSubPath

+ var AllowedSourceFilesHashTypes = map[fileutils.HashType]bool

+ var ErrCircularInclude = errors.New("circular include detected")

+ var ErrDuplicatePackageGroups = errors.New("duplicate package group")

+ var ErrDuplicateTestSuites = errors.New("duplicate test suite")

+ var ErrInvalidInstallMode = errors.New("invalid install mode")

+ var ErrMismatchedTestSubtable = errors.New("mismatched test subtable")

+ var ErrMissingTestField = errors.New("missing required test field")

+ var ErrOverlayFileEmpty = errors.New("overlay file declares no overlays")

+ var ErrOverlayFilePerOverlayMetadata = errors.New(...)

+ var ErrOverlayFilesNoMatches = errors.New("overlay-files pattern matched no files")

+ var ErrUndefinedComponent = errors.New("undefined component reference")

+ var ErrUndefinedTestSuite = errors.New("undefined test suite reference")

+ var ErrUnknownTestType = errors.New("unknown test type")

+ func IsDebugInfoPackage(pkgName string) bool

+ func ResolvePackagePublishChannel(pkgName string, comp *ComponentConfig, proj *ProjectConfig) (string, error)

+ func UserConfigFilePath(osEnv opctx.OSEnv) string

type ComponentBuildFailureConfig

+ func (c *ComponentBuildFailureConfig) Validate() error

type ComponentConfig

+ Locked *ComponentLockData

+ OverlayFiles []string

+ Packages map[string]PackageConfig

+ Publish ComponentPublishConfig

+ Release ReleaseConfig

+ Render ComponentRenderConfig

+ RenderedSpecDir string

+ func ExpandResolvedOverlayFiles(fs opctx.FS, component ComponentConfig, referenceDir string, ...) (ComponentConfig, error)

+ func ResolveComponentConfig(comp ComponentConfig, projectDefaults ComponentConfig, ...) (ComponentConfig, error)

+ func (c *ComponentConfig) EffectiveUpstreamCommit() string

type ComponentGroupConfig

+ Metadata *OverlayMetadata

+ type ComponentLockData struct

+ Freshness FreshnessStatus

+ ImportCommit string

+ InputFingerprint string

+ ManualBump int

+ ResolutionInputHash string

+ ResolutionStale bool

+ UpstreamCommit string

type ComponentOverlay

+ Archive string

+ Metadata *OverlayMetadata

+ func (c *ComponentOverlay) ArchiveTarget() (archiveName, innerPath string, ok bool)

+ func (c *ComponentOverlay) EffectiveSourceName() string

+ func (c *ComponentOverlay) ModifiesArchive() bool

+ func (c *ComponentOverlay) ModifiesLooseFiles() bool

+ func (c *ComponentOverlay) SourceContentIdentity(fs opctx.FS) (string, error)

+ func (c *ComponentOverlay) SupportsArchiveScope() bool

+ func (c ComponentOverlay) HashInclude(field string, _ any) (bool, error)

type ComponentOverlayType

+ const ComponentOverlayRemoveSection

+ const ComponentOverlayRemoveSubpackage

+ type ComponentPublishConfig struct

+ DebugInfoChannel string

+ RPMChannel string

+ SRPMChannel string

+ type ComponentRenderConfig struct

+ SkipFileFilter bool

type ConfigFile

+ DefaultComponentConfig *ComponentConfig

+ DefaultPackageConfig *PackageConfig

+ PackageGroups map[string]PackageGroupConfig

+ Resources *ResourcesConfig

+ TestSuites map[string]TestSuiteConfig

+ func (f ConfigFile) Dir() string

+ func (f ConfigFile) SourcePath() string

type DistroVersionDefinition

+ Inputs DistroVersionInputs

+ func (v DistroVersionDefinition) EffectiveImageBuildRepos(resources *ResourcesConfig) ([]string, error)

+ func (v DistroVersionDefinition) EffectiveRpmBuildRepos(resources *ResourcesConfig) ([]string, error)

+ type DistroVersionInput struct

+ Repo string

+ Set string

+ type DistroVersionInputs struct

+ ImageBuild []DistroVersionInput

+ RpmBuild []DistroVersionInput

+ type FreshnessStatus int

+ const FreshnessCurrent

+ const FreshnessStale

+ const FreshnessUnknown

+ func (f FreshnessStatus) String() string

+ type ImageCapabilities struct

+ Container *bool

+ MachineBootable *bool

+ RuntimePackageManagement *bool

+ Systemd *bool

+ func (c *ImageCapabilities) EnabledNames() []string

+ func (c *ImageCapabilities) IsContainer() bool

+ func (c *ImageCapabilities) IsMachineBootable() bool

+ func (c *ImageCapabilities) IsRuntimePackageManagement() bool

+ func (c *ImageCapabilities) IsSystemd() bool

type ImageConfig

+ Capabilities ImageCapabilities

+ Publish ImagePublishConfig

+ Tests ImageTestsConfig

+ func (i *ImageConfig) TestNames() []string

+ type ImagePublishConfig struct

+ Channels []string

+ type ImageTestsConfig struct

+ TestSuites []TestSuiteRef

type Origin

+ Inputs []string

+ MockPackages []string

+ Script string

+ func (o Origin) HashInclude(field string, _ any) (bool, error)

type OriginType

+ const OriginTypeCustom

+ type OverlayCategory string

+ const OverlayCategoryAZLBrandingPolicy

+ const OverlayCategoryAZLCompatibility

+ const OverlayCategoryAZLDisableFlakyTests

+ const OverlayCategoryAZLDisableUnsupportedTests

+ const OverlayCategoryAZLPlatformAdaptation

+ const OverlayCategoryAZLPruning

+ const OverlayCategoryAZLReleaseManagement

+ const OverlayCategoryAZLSecurityCompliance

+ const OverlayCategoryAZLTemporaryWorkaround

+ const OverlayCategoryUpstreamBackport

+ func (c OverlayCategory) IsValid() bool

+ type OverlayFile struct

+ Metadata OverlayMetadata

+ Overlays []ComponentOverlay

+ type OverlayMetadata struct

+ Bugs []URLRef

+ Category OverlayCategory

+ Commits []URLRef

+ UpstreamStatus OverlayUpstreamStatus

+ func (m *OverlayMetadata) Validate() error

+ type OverlayUpstreamStatus string

+ const OverlayUpstreamStatusInapplicable

+ const OverlayUpstreamStatusNeedsUpstreamHook

+ const OverlayUpstreamStatusUnknown

+ const OverlayUpstreamStatusUpstreamable

+ const OverlayUpstreamStatusUpstreamed

+ func (s OverlayUpstreamStatus) IsValid() bool

+ type PackageConfig struct

+ Publish PackagePublishConfig

+ func ResolvePackageConfig(pkgName string, comp *ComponentConfig, proj *ProjectConfig) (PackageConfig, error)

+ func (p *PackageConfig) MergeUpdatesFrom(other *PackageConfig) error

+ type PackageGroupConfig struct

+ DefaultPackageConfig PackageConfig

+ Description string

+ Packages []string

+ func (g *PackageGroupConfig) Validate() error

+ type PackagePublishConfig struct

+ DebugInfoChannel string

+ DeprecatedChannel string

+ RPMChannel string

+ func (p PackagePublishConfig) EffectiveRPMChannel() string

type ProjectConfig

+ DefaultComponentConfig ComponentConfig

+ DefaultPackageConfig PackageConfig

+ PackageGroups map[string]PackageGroupConfig

+ Resources ResourcesConfig

+ TestSuites map[string]TestSuiteConfig

type ProjectInfo

+ DefaultAuthorEmail string

+ LockDir string

+ RenderedSpecsDir string

+ func (p *ProjectInfo) ApplyProjectDefaults(projectDir string)

+ type PytestConfig struct

+ ExtraArgs []string

+ Install PytestInstallMode

+ TestPaths []string

+ WorkingDir string

+ func (p *PytestConfig) EffectiveInstallMode() PytestInstallMode

+ func (p *PytestConfig) Validate() error

+ type PytestInstallMode string

+ const PytestInstallNone

+ const PytestInstallPyproject

+ const PytestInstallRequirements

+ type ReleaseCalculation string

+ const ReleaseCalculationAuto

+ const ReleaseCalculationAutorelease

+ const ReleaseCalculationManual

+ const ReleaseCalculationStatic

+ type ReleaseConfig struct

+ Calculation ReleaseCalculation

+ type ResourcesConfig struct

+ RpmRepoSetTemplates map[string]RpmRepoSetTemplate

+ RpmRepoSets map[string]RpmRepoSet

+ RpmRepos map[string]RpmRepoResource

+ func (ResourcesConfig) JSONSchemaExtend(schema *jsonschema.Schema)

+ func (r *ResourcesConfig) EffectiveRpmRepos() (map[string]RpmRepoResource, error)

+ func (r *ResourcesConfig) IsEmpty() bool

+ func (r *ResourcesConfig) MergeUpdatesFrom(other *ResourcesConfig)

+ func (r *ResourcesConfig) WithAbsolutePaths(referenceDir string) *ResourcesConfig

+ type RpmRepoResource struct

+ Arches []string

+ BaseURI string

+ Description string

+ DisableGPGCheck bool

+ GPGKey string

+ Metalink string

+ Type RpmRepoType

+ func (RpmRepoResource) JSONSchemaExtend(schema *jsonschema.Schema)

+ func (r *RpmRepoResource) EffectiveType() RpmRepoType

+ func (r *RpmRepoResource) IsAvailableForArch(arch string) bool

+ func (r *RpmRepoResource) IsLocalGPGKey() bool

+ type RpmRepoSet struct

+ Arches []string

+ BaseURI string

+ Description string

+ DisableGPGCheck bool

+ GPGKey string

+ NamePrefix string

+ Subrepos []string

+ Template string

+ type RpmRepoSetTemplate struct

+ Description string

+ Subrepos []SubrepoSpec

+ type RpmRepoType string

+ const RpmRepoTypeRpmMd

+ func (t RpmRepoType) IsValid() bool

type SourceFileReference

+ ReplaceReason string

+ ReplaceUpstream bool

+ func (r SourceFileReference) HashInclude(field string, _ any) (bool, error)

+ type SubrepoKind string

+ const SubrepoKindBinary

+ const SubrepoKindDebug

+ const SubrepoKindSource

+ func (k SubrepoKind) Default() SubrepoKind

+ func (k SubrepoKind) IsValid() bool

+ type SubrepoSpec struct

+ Kind SubrepoKind

+ Name string

+ Subpath string

+ type TestSuiteConfig struct

+ Description string

+ Name string

+ Pytest *PytestConfig

+ SourceConfigFile *ConfigFile

+ Type TestType

+ func (t *TestSuiteConfig) MergeUpdatesFrom(other *TestSuiteConfig) error

+ func (t *TestSuiteConfig) Validate() error

+ func (t *TestSuiteConfig) WithAbsolutePaths(referenceDir string) *TestSuiteConfig

+ type TestSuiteRef struct

+ Name string

+ type TestType string

+ const TestTypeLisa

+ const TestTypePytest

+ type URLRef struct

+ URL string

v0.1.0

Mar 18, 2026

Changes in this version

+ const DefaultConfigFileName

+ const DefaultSchemaURI

+ const HashTypeSHA256

+ const HashTypeSHA512

+ var ErrConfigFileNotFound = errors.New("could not find config file: azldev.toml")

+ var ErrDuplicateComponentGroups = errors.New("duplicate component group")

+ var ErrDuplicateComponents = errors.New("duplicate component")

+ var ErrDuplicateImages = errors.New("duplicate image")

+ func FindProjectRootAndConfigFile(fs opctx.FS, referenceDir string) (projectRootDir, configFilePath string, err error)

+ type CheckConfig struct

+ Skip bool

+ SkipReason string

+ func (c *CheckConfig) Validate() error

+ type ComponentBuildConfig struct

+ Check CheckConfig

+ Defines map[string]string

+ Failure ComponentBuildFailureConfig

+ Hints ComponentBuildHints

+ Undefines []string

+ With []string

+ Without []string

+ func (c *ComponentBuildConfig) Validate() error

+ type ComponentBuildFailureConfig struct

+ Expected bool

+ ExpectedReason string

+ type ComponentBuildHints struct

+ Expensive bool

+ type ComponentConfig struct

+ Build ComponentBuildConfig

+ Name string

+ Overlays []ComponentOverlay

+ SourceConfigFile *ConfigFile

+ SourceFiles []SourceFileReference

+ Spec SpecSource

+ func (c *ComponentConfig) MergeUpdatesFrom(other *ComponentConfig) error

+ func (c *ComponentConfig) WithAbsolutePaths(referenceDir string) *ComponentConfig

+ type ComponentGroupConfig struct

+ Components []string

+ DefaultComponentConfig ComponentConfig

+ Description string

+ ExcludedPathPatterns []string

+ SpecPathPatterns []string

+ func (g ComponentGroupConfig) WithAbsolutePaths(referenceDir string) ComponentGroupConfig

+ type ComponentOverlay struct

+ Description string

+ Filename string

+ Lines []string

+ PackageName string

+ Regex string

+ Replacement string

+ SectionName string

+ Source string

+ Tag string

+ Type ComponentOverlayType

+ Value string

+ func (c *ComponentOverlay) ModifiesNonSpecFiles() bool

+ func (c *ComponentOverlay) ModifiesSpec() bool

+ func (c *ComponentOverlay) Validate() error

+ func (c *ComponentOverlay) WithAbsolutePaths(referenceDir string) (result *ComponentOverlay)

+ type ComponentOverlayType string

+ const ComponentOverlayAddFile

+ const ComponentOverlayAddPatch

+ const ComponentOverlayAddSpecTag

+ const ComponentOverlayAppendSpecLines

+ const ComponentOverlayInsertSpecTag

+ const ComponentOverlayPrependLinesToFile

+ const ComponentOverlayPrependSpecLines

+ const ComponentOverlayRemoveFile

+ const ComponentOverlayRemovePatch

+ const ComponentOverlayRemoveSpecTag

+ const ComponentOverlayRenameFile

+ const ComponentOverlaySearchAndReplaceInFile

+ const ComponentOverlaySearchAndReplaceInSpec

+ const ComponentOverlaySetSpecTag

+ const ComponentOverlayUpdateSpecTag

+ type ComponentReference struct

+ Name string

+ Version *rpm.Version

+ type ConfigFile struct

+ ComponentGroups map[string]ComponentGroupConfig

+ Components map[string]ComponentConfig

+ Distros map[string]DistroDefinition

+ Images map[string]ImageConfig

+ Includes []string

+ Project *ProjectInfo

+ SchemaURI string

+ Tools *ToolsConfig

+ func (f ConfigFile) Serialize(fs opctx.FS, filePath string) error

+ func (f ConfigFile) ToBytes() ([]byte, error)

+ func (f ConfigFile) Validate() error

+ type DistroDefinition struct

+ DefaultVersion string

+ Description string

+ DisableOrigins bool

+ DistGitBaseURI string

+ LookasideBaseURI string

+ PackageRepositories []PackageRepository

+ Versions map[string]DistroVersionDefinition

+ func (d *DistroDefinition) MergeUpdatesFrom(other *DistroDefinition) error

+ func (d *DistroDefinition) WithAbsolutePaths(referenceDir string) DistroDefinition

+ func (d *DistroDefinition) WithResolvedConfigs() DistroDefinition

+ type DistroReference struct

+ Name string

+ Snapshot string

+ Version string

+ func (r *DistroReference) String() string

+ type DistroVersionDefinition struct

+ DefaultComponentConfig ComponentConfig

+ Description string

+ DistGitBranch string

+ MockConfigPath string

+ MockConfigPathAarch64 string

+ MockConfigPathX86_64 string

+ ReleaseVer string

+ func (v DistroVersionDefinition) WithAbsolutePaths(referenceDir string) DistroVersionDefinition

+ func (v DistroVersionDefinition) WithResolvedConfigs() DistroVersionDefinition

+ type ImageConfig struct

+ Definition ImageDefinition

+ Description string

+ Name string

+ SourceConfigFile *ConfigFile

+ func (i *ImageConfig) MergeUpdatesFrom(other *ImageConfig) error

+ func (i *ImageConfig) WithAbsolutePaths(referenceDir string) *ImageConfig

+ type ImageCustomizerConfig struct

+ ContainerTag string

+ type ImageDefinition struct

+ DefinitionType ImageDefinitionType

+ Path string

+ Profile string

+ type ImageDefinitionType string

+ const ImageDefinitionTypeKiwi

+ const ImageDefinitionTypeUnspecified

+ type Origin struct

+ Type OriginType

+ Uri string

+ type OriginType string

+ const OriginTypeURI

+ type PackageRepository struct

+ BaseURI string

+ func (r PackageRepository) WithAbsolutePaths(referenceDir string) PackageRepository

+ type ProjectConfig struct

+ ComponentGroups map[string]ComponentGroupConfig

+ Components map[string]ComponentConfig

+ Distros map[string]DistroDefinition

+ GroupsByComponent map[string][]string

+ Images map[string]ImageConfig

+ Project ProjectInfo

+ RootConfigFilePath string

+ Tools ToolsConfig

+ func LoadProjectConfig(dryRunnable opctx.DryRunnable, fs opctx.FS, referenceDir string, ...) (projectDir string, config *ProjectConfig, err error)

+ func NewProjectConfig() ProjectConfig

+ func (cfg *ProjectConfig) Validate() error

+ type ProjectInfo struct

+ DefaultDistro DistroReference

+ Description string

+ LogDir string

+ OutputDir string

+ WorkDir string

+ func (p *ProjectInfo) MergeUpdatesFrom(other *ProjectInfo) error

+ func (p *ProjectInfo) WithAbsolutePaths(referenceDir string) *ProjectInfo

+ type SourceFileReference struct

+ Component ComponentReference

+ Filename string

+ Hash string

+ HashType fileutils.HashType

+ Origin Origin

+ type SpecSource struct

+ Path string

+ SourceType SpecSourceType

+ UpstreamCommit string

+ UpstreamDistro DistroReference

+ UpstreamName string

+ func (s *SpecSource) String() string

+ type SpecSourceType string

+ const SpecSourceTypeLocal

+ const SpecSourceTypeUnspecified

+ const SpecSourceTypeUpstream

+ type ToolsConfig struct

+ ImageCustomizer ImageCustomizerConfig

+ func (tc *ToolsConfig) MergeUpdatesFrom(other *ToolsConfig) error

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