build

package

Go to main page

Versions in this module

v0

v0.6.11

Apr 8, 2024

v0.6.10

Mar 26, 2024

v0.6.9

Mar 6, 2024

v0.6.8

Mar 5, 2024

v0.6.7

Mar 4, 2024

v0.6.6

Mar 2, 2024

v0.6.5

Feb 29, 2024

v0.6.4

Feb 24, 2024

v0.6.3

Feb 20, 2024

v0.6.2

Feb 20, 2024

Changes in this version

type Build

+ ExtraPackages []string

type Option

+ func WithExtraPackages(extraPackages []string) Option

v0.6.1

Feb 14, 2024

v0.6.0

Feb 10, 2024

Changes in this version

type Build

+ Interactive bool

type Option

+ func WithInteractive(interactive bool) Option

type PipelineBuild

+ func (pb *PipelineBuild) Interactive() bool

type Test

+ Interactive bool

type TestOption

+ func WithTestInteractive(interactive bool) TestOption

v0.5.10

Feb 7, 2024

v0.5.9

Feb 6, 2024

v0.5.8

Feb 6, 2024

Changes in this version

type Build

+ Remove bool

+ func (b *Build) Close() error

type Option

+ func WithRemove(remove bool) Option

type Test

+ func (t *Test) Close() error

v0.5.7

Feb 3, 2024

Changes in this version

type PackageBuild

+ MelangeVersion string

v0.5.6

Jan 20, 2024

Changes in this version

type Test

+ ExtraTestPackages []string

type TestOption

+ func WithExtraTestPackages(extraTestPackages []string) TestOption

v0.5.5

Dec 21, 2023

v0.5.4

Dec 4, 2023

Changes in this version

type Build

+ DefaultCPU string

+ DefaultMemory string

+ DefaultTimeout time.Duration

+ PipelineDirs []string

type Option

+ func WithCPU(cpu string) Option

+ func WithMemory(memory string) Option

+ func WithTimeout(dur time.Duration) Option

type PipelineBuild

+ Test *Test

+ func (pb *PipelineBuild) GetConfiguration() *config.Configuration

+ func (pb *PipelineBuild) GetRunner() container.Runner

type PipelineContext

+ Environment *apko_types.ImageConfiguration

+ PipelineDirs []string

+ WorkspaceConfig *container.Config

+ type Runner string

+ type Test struct

+ ApkCacheDir string

+ Arch apko_types.Architecture

+ BinShOverlay string

+ CacheDir string

+ CacheSource string

+ ConfigFile string

+ Configuration config.Configuration

+ Debug bool

+ DebugRunner bool

+ ExtraKeys []string

+ ExtraRepos []string

+ GuestDir string

+ LogPolicy []string

+ Logger apko_log.Logger

+ Package string

+ PipelineDirs []string

+ Runner container.Runner

+ RunnerName string

+ SourceDir string

+ WorkspaceDir string

+ WorkspaceIgnore string

+ func NewTest(ctx context.Context, opts ...TestOption) (*Test, error)

+ func (t *Test) BuildGuest(ctx context.Context, imgConfig *apko_types.ImageConfiguration, suffix string) (string, error)

+ func (t *Test) IsTestless() bool

+ func (t *Test) OverlayBinSh(suffix string) error

+ func (t *Test) PopulateCache(ctx context.Context) error

+ func (t *Test) PopulateWorkspace(ctx context.Context) error

+ func (t *Test) Summarize()

+ func (t *Test) SummarizePaths()

+ func (t *Test) TestPackage(ctx context.Context) error

+ type TestOption func(*Test) error

+ func WithTestArch(arch apko_types.Architecture) TestOption

+ func WithTestBinShOverlay(binShOverlay string) TestOption

+ func WithTestCacheDir(cacheDir string) TestOption

+ func WithTestCacheSource(sourceDir string) TestOption

+ func WithTestConfig(configFile string) TestOption

+ func WithTestDebug(debug bool) TestOption

+ func WithTestDebugRunner(debugRunner bool) TestOption

+ func WithTestExtraKeys(extraKeys []string) TestOption

+ func WithTestExtraRepos(extraRepos []string) TestOption

+ func WithTestGuestDir(guestDir string) TestOption

+ func WithTestLogPolicy(policy []string) TestOption

+ func WithTestPackage(pkg string) TestOption

+ func WithTestPackageCacheDir(apkCacheDir string) TestOption

+ func WithTestPipelineDir(pipelineDir string) TestOption

+ func WithTestRunner(runner string) TestOption

+ func WithTestSourceDir(sourceDir string) TestOption

+ func WithTestWorkspaceDir(workspaceDir string) TestOption

+ func WithTestWorkspaceIgnore(workspaceIgnore string) TestOption

v0.5.3

Nov 15, 2023

v0.5.2

Nov 8, 2023

Changes in this version

type PipelineBuild

+ func (pb *PipelineBuild) Emit(ctx context.Context, pkg *config.Package) error

+ func (pb *PipelineBuild) ShouldRun(sp config.Subpackage) (bool, error)

+ type SCABuildInterface struct

+ PackageBuild *PackageBuild

+ func (sca *SCABuildInterface) BaseDependencies() config.Dependencies

+ func (sca *SCABuildInterface) Filesystem() (sca.SCAFS, error)

+ func (sca *SCABuildInterface) Logger() log.Logger

+ func (sca *SCABuildInterface) Options() config.PackageOption

+ func (sca *SCABuildInterface) PackageName() string

+ func (sca *SCABuildInterface) RelativeNames() []string

+ func (sca *SCABuildInterface) Version() string

+ func (scabi *SCABuildInterface) FilesystemForRelative(pkgName string) (sca.SCAFS, error)

v0.5.1

Oct 16, 2023

v0.5.0

Oct 4, 2023

Changes in this version

+ func EmitSignature(ctx context.Context, signer ApkSigner, controlData []byte, sde time.Time) ([]byte, error)

+ type ApkSigner interface

+ Sign func(controlData []byte) ([]byte, error)

+ SignatureName func() string

+ type Build struct

+ ApkCacheDir string

+ Arch apko_types.Architecture

+ BinShOverlay string

+ BreakpointLabel string

+ BuiltinPipelineDir string

+ CacheDir string

+ CacheSource string

+ ConfigFile string

+ Configuration config.Configuration

+ ContinueLabel string

+ CreateBuildLog bool

+ Debug bool

+ DebugRunner bool

+ DependencyLog string

+ EmptyWorkspace bool

+ EnabledBuildOptions []string

+ EnvFile string

+ ExtraKeys []string

+ ExtraRepos []string

+ FailOnLintWarning bool

+ GenerateIndex bool

+ GuestDir string

+ LogPolicy []string

+ Logger apko_log.Logger

+ Namespace string

+ OutDir string

+ PipelineDir string

+ Runner container.Runner

+ RunnerName string

+ SigningKey string

+ SigningPassphrase string

+ SourceDateEpoch time.Time

+ SourceDir string

+ StripOriginName bool

+ VarsFile string

+ WorkspaceDir string

+ WorkspaceIgnore string

+ func (b *Build) ApplyBuildOption(bo config.BuildOption) error

+ func (b *Build) BuildFlavor() string

+ func (b *Build) BuildGuest(ctx context.Context) error

+ func (b *Build) BuildPackage(ctx context.Context) error

+ func (b *Build) BuildTripletGnu() string

+ func (b *Build) BuildTripletRust() string

+ func (b *Build) IsBuildLess() bool

+ func (b *Build) LoadIgnoreRules() error

+ func (b *Build) OverlayBinSh() error

+ func (b *Build) PopulateCache(ctx context.Context) error

+ func (b *Build) PopulateWorkspace(ctx context.Context) error

+ func (b *Build) RetrieveWorkspace(ctx context.Context) error

+ func (b *Build) Summarize()

+ func (b *Build) SummarizePaths()

+ func (b *Build) WorkspaceConfig() *container.Config

+ type FulcioApkSigner struct

+ func (*FulcioApkSigner) Sign(control []byte) ([]byte, error)

+ func (*FulcioApkSigner) SignatureName() string

+ type KeyApkSigner struct

+ KeyFile string

+ KeyPassphrase string

+ func (s KeyApkSigner) Sign(control []byte) ([]byte, error)

+ func (s KeyApkSigner) SignatureName() string

type Option

+ func WithDebugRunner(debug bool) Option

+ func WithFailOnLintWarning(fail bool) Option

+ type PackageBuild struct

+ Arch string

+ Build *Build

+ Commit string

+ DataHash string

+ Dependencies config.Dependencies

+ Description string

+ InstalledSize int64

+ Logger log.Logger

+ Options config.PackageOption

+ Origin *PackageContext

+ OriginName string

+ OutDir string

+ PackageName string

+ Scriptlets config.Scriptlets

+ URL string

+ func (pc *PackageBuild) AppendBuildLog(dir string) error

+ func (pc *PackageBuild) EmitPackage(ctx context.Context) error

+ func (pc *PackageBuild) Filename() string

+ func (pc *PackageBuild) GenerateControlData(w io.Writer) error

+ func (pc *PackageBuild) GenerateDependencies() error

+ func (pc *PackageBuild) Identity() string

+ func (pc *PackageBuild) SignatureName() string

+ func (pc *PackageBuild) Signer() ApkSigner

+ func (pc *PackageBuild) WorkspaceSubdir() string

type PackageContext

+ Package *config.Package

+ func NewPackageContext(pkg *config.Package) (*PackageContext, error)

+ func (pkg *PackageContext) Emit(ctx context.Context, pb *PipelineBuild) error

+ type PipelineBuild struct

+ Build *Build

+ Package *PackageContext

+ Subpackage *SubpackageContext

type PipelineContext

+ Pipeline *config.Pipeline

+ func NewPipelineContext(p *config.Pipeline, logger apko_log.Logger) (*PipelineContext, error)

+ func NewPipelineContextFromPipelineBuild(pb *PipelineBuild) (*PipelineContext, error)

+ func (pctx *PipelineContext) ApplyNeeds(pb *PipelineBuild) error

+ func (pctx *PipelineContext) Identity() string

+ func (pctx *PipelineContext) Run(ctx context.Context, pb *PipelineBuild) (bool, error)

+ type SubpackageContext struct

+ Subpackage *config.Subpackage

+ func NewSubpackageContext(pkg *config.Subpackage) (*SubpackageContext, error)

+ func (sp SubpackageContext) ShouldRun(pb *PipelineBuild) (bool, error)

+ func (spkg *SubpackageContext) Emit(ctx context.Context, pb *PipelineBuild) error

v0.4.0

Jun 30, 2023

Changes in this version

+ var ErrSkipThisArch = errors.New("error: skip this arch")

+ func GetAllRunners() []runner

+ func GetDefaultRunner() runner

+ func MutateStringFromMap(with map[string]string, input string) (string, error)

+ func MutateWith(ctx *PipelineContext, with map[string]string) (map[string]string, error)

type Configuration

+ func (cfg Configuration) Name() string

type Context

+ ApkCacheDir string

+ LogPolicy []string

+ RunnerName string

+ func (ctx *Context) IsBuildLess() bool

+ func (ctx *Context) RetrieveWorkspace(sigh context.Context, cfg *container.Config) error

+ type DataItems map[string]string

+ type ErrInvalidConfiguration struct

+ Problem error

+ func (e ErrInvalidConfiguration) Error() string

type GitHubMonitor

+ StripSuffix string

type Option

+ func WithLogPolicy(policy []string) Option

+ func WithPackageCacheDir(apkCacheDir string) Option

+ func WithRunner(runner string) Option

type PackageContext

+ func (pc *PackageContext) AppendBuildLog(dir string) error

type ReleaseMonitor

+ StripPrefix string

+ StripSuffix string

type Update

+ IgnoreRegexPatterns []string

+ Manual bool

v0.3.2

Mar 31, 2023

v0.3.1

Mar 31, 2023

v0.3.0

Mar 29, 2023

Changes in this version

+ type Advisories map[string][]AdvisoryContent

+ type AdvisoryContent struct

+ ActionStatement string

+ FixedVersion string

+ ImpactStatement string

+ Justification vex.Justification

+ Status vex.Status

+ Timestamp time.Time

+ func (ac AdvisoryContent) Validate() error

+ type BuildOption struct

+ Environment EnvironmentOption

+ Vars map[string]string

+ func (bo BuildOption) Apply(ctx *Context) error

type Configuration

+ Advisories Advisories

+ Options map[string]BuildOption

+ Secfixes Secfixes

+ Update Update

+ VarTransforms []VarTransforms

+ Vars map[string]string

+ func ParseConfiguration(configurationFilePath string, opts ...ConfigurationParsingOption) (*Configuration, error)

+ func (cfg Configuration) PackageURLs(distro string) []string

+ type ConfigurationParsingOption func(*configOptions)

+ func WithEnvFileForParsing(path string) ConfigurationParsingOption

+ func WithFS(filesystem fs.FS) ConfigurationParsingOption

+ func WithLogger(logger Logger) ConfigurationParsingOption

+ func WithVarsFileForParsing(path string) ConfigurationParsingOption

+ type ContentsOption struct

+ Packages ListOption

type Context

+ CacheSource string

+ CreateBuildLog bool

+ Debug bool

+ EnabledBuildOptions []string

+ Namespace string

+ VarsFile string

+ func (ctx *Context) GenerateBuildLog(dir string) error

type Dependencies

+ ProviderPriority int

+ Replaces []string

+ type EnvironmentOption struct

+ Contents ContentsOption

+ type GitHubMonitor struct

+ Identifier string

+ StripPrefix string

+ TagFilter string

+ UseTags bool

+ type ListOption struct

+ Add []string

+ Remove []string

+ type Logger interface

+ Printf func(format string, v ...any)

+ SetPrefix func(prefix string)

type Option

+ func WithCacheSource(sourceDir string) Option

+ func WithCreateBuildLog(createBuildLog bool) Option

+ func WithDebug(debug bool) Option

+ func WithEnabledBuildOptions(enabledBuildOptions []string) Option

+ func WithNamespace(namespace string) Option

+ func WithVarsFile(varsFile string) Option

type Package

+ func (p Package) PackageURL(distro string) string

type Pipeline

+ WorkDir string

+ type ReleaseMonitor struct

+ Identifier int

+ type Secfixes map[string][]string

type Subpackage

+ If string

+ func (sp Subpackage) ShouldRun(pctx *PipelineContext) (bool, error)

+ func (spkg Subpackage) PackageURL(distro, packageVersionWithRelease string) string

+ type Update struct

+ Enabled bool

+ GitHubMonitor *GitHubMonitor

+ ReleaseMonitor *ReleaseMonitor

+ Shared bool

+ VersionSeparator string

+ type VarTransforms struct

+ From string

+ Match string

+ Replace string

+ To string

v0.2.0

Dec 22, 2022

Changes in this version

+ type CacheMembershipMap map[string]bool

type Configuration

+ Data []RangeData

type Context

+ BinShOverlay string

+ BreakpointLabel string

+ BuiltinPipelineDir string

+ CacheDir string

+ ContinueLabel string

+ DependencyLog string

+ EnvFile string

+ GenerateIndex bool

+ Runner container.Runner

+ StripOriginName bool

+ func (ctx *Context) BuildAndPushLocalImage(bc *apko_build.Context) error

+ func (ctx *Context) BuildFlavor() string

+ func (ctx *Context) BuildGuest() error

+ func (ctx *Context) BuildTripletGnu() string

+ func (ctx *Context) BuildTripletRust() string

+ func (ctx *Context) OverlayBinSh() error

+ func (ctx *Context) PopulateCache() error

+ func (ctx *Context) SummarizePaths()

+ func (ctx *Context) WorkspaceConfig() *container.Config

+ type DataItem struct

+ Key string

+ Value string

+ type DataItemList []DataItem

+ func (d *DataItemList) MarshalYAML() (interface{}, error)

+ func (d *DataItemList) UnmarshalYAML(n *yaml.Node) error

type Option

+ func WithBinShOverlay(binShOverlay string) Option

+ func WithBreakpointLabel(breakpointLabel string) Option

+ func WithBuiltinPipelineDirectory(builtinPipelineDir string) Option

+ func WithCacheDir(cacheDir string) Option

+ func WithContinueLabel(continueLabel string) Option

+ func WithDependencyLog(logFile string) Option

+ func WithEnvFile(envFile string) Option

+ func WithGenerateIndex(generateIndex bool) Option

+ func WithGuestDir(guestDir string) Option

+ func WithStripOriginName(stripOriginName bool) Option

type Package

+ Commit string

+ Options PackageOption

+ Scriptlets Scriptlets

+ URL string

+ func (p *Package) FullCopyright() string

+ func (p *Package) LicenseExpression() string

type PackageContext

+ Arch string

+ Commit string

+ Description string

+ Options PackageOption

+ OriginName string

+ Scriptlets Scriptlets

+ URL string

+ type PackageOption struct

+ NoCommands bool

+ NoDepends bool

+ NoProvides bool

type Pipeline

+ Assertions PipelineAssertions

+ If string

+ Label string

+ SBOM SBOM

+ type PipelineAssertions struct

+ RequiredSteps int

+ type RangeData struct

+ Items DataItemList

+ Name string

+ type SBOM struct

+ Language string

+ type Scriptlets struct

+ PostDeinstall string

+ PostInstall string

+ PostUpgrade string

+ PreDeinstall string

+ PreInstall string

+ PreUpgrade string

+ Trigger struct{ ... }

type Subpackage

+ Commit string

+ Description string

+ Options PackageOption

+ Range string

+ Scriptlets Scriptlets

+ URL string

v0.1.0

Jun 2, 2022

Changes in this version

+ type Configuration struct

+ Environment apko_types.ImageConfiguration

+ Package Package

+ Pipeline []Pipeline

+ Subpackages []Subpackage

+ func (cfg *Configuration) Load(configFile string) error

+ type Context struct

+ Arch apko_types.Architecture

+ ConfigFile string

+ Configuration Configuration

+ EmptyWorkspace bool

+ ExtraKeys []string

+ ExtraRepos []string

+ GuestDir string

+ Logger *log.Logger

+ OutDir string

+ PipelineDir string

+ SigningKey string

+ SigningPassphrase string

+ SourceDateEpoch time.Time

+ SourceDir string

+ UseProot bool

+ WorkspaceDir string

+ WorkspaceIgnore string

+ func New(opts ...Option) (*Context, error)

+ func (ctx *Context) BuildPackage() error

+ func (ctx *Context) BuildWorkspace(workspaceDir string) error

+ func (ctx *Context) LoadIgnoreRules() error

+ func (ctx *Context) PopulateWorkspace() error

+ func (ctx *Context) PrivilegedWorkspaceCmd(args ...string) (*exec.Cmd, error)

+ func (ctx *Context) Summarize()

+ func (ctx *Context) WorkspaceCmd(args ...string) (*exec.Cmd, error)

+ type Copyright struct

+ Attestation string

+ License string

+ Paths []string

+ type Dependencies struct

+ Provides []string

+ Runtime []string

+ func (dep *Dependencies) Summarize(logger *log.Logger)

+ type DependencyGenerator func(*PackageContext, *Dependencies) error

+ type Input struct

+ Default string

+ Description string

+ Required bool

+ type Needs struct

+ Packages []string

+ type Option func(*Context) error

+ func WithArch(arch apko_types.Architecture) Option

+ func WithBuildDate(s string) Option

+ func WithConfig(configFile string) Option

+ func WithEmptyWorkspace(emptyWorkspace bool) Option

+ func WithExtraKeys(extraKeys []string) Option

+ func WithExtraRepos(extraRepos []string) Option

+ func WithOutDir(outDir string) Option

+ func WithPipelineDir(pipelineDir string) Option

+ func WithSigningKey(signingKey string) Option

+ func WithSourceDir(sourceDir string) Option

+ func WithUseProot(useProot bool) Option

+ func WithWorkspaceDir(workspaceDir string) Option

+ func WithWorkspaceIgnore(workspaceIgnore string) Option

+ type Package struct

+ Copyright []Copyright

+ Dependencies Dependencies

+ Description string

+ Epoch uint64

+ Name string

+ TargetArchitecture []string

+ Version string

+ func (pkg *Package) Emit(ctx *PipelineContext) error

+ type PackageContext struct

+ Context *Context

+ DataHash string

+ Dependencies Dependencies

+ InstalledSize int64

+ Logger *log.Logger

+ Origin *Package

+ OutDir string

+ PackageName string

+ func (pc *PackageContext) EmitPackage() error

+ func (pc *PackageContext) Filename() string

+ func (pc *PackageContext) GenerateControlData(w io.Writer) error

+ func (pc *PackageContext) GenerateDependencies() error

+ func (pc *PackageContext) Identity() string

+ func (pc *PackageContext) SignatureName() string

+ func (pc *PackageContext) WorkspaceSubdir() string

+ type Pipeline struct

+ Inputs map[string]Input

+ Name string

+ Needs Needs

+ Pipeline []Pipeline

+ Runs string

+ Uses string

+ With map[string]string

+ func NewPipeline(ctx *PipelineContext) (*Pipeline, error)

+ func (p *Pipeline) ApplyNeeds(ctx *PipelineContext) error

+ func (p *Pipeline) Identity() string

+ func (p *Pipeline) Run(ctx *PipelineContext) error

+ type PipelineContext struct

+ Context *Context

+ Package *Package

+ Subpackage *Subpackage

+ type Subpackage struct

+ Dependencies Dependencies

+ Name string

+ Pipeline []Pipeline

+ func (spkg *Subpackage) Emit(ctx *PipelineContext) error

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