build

package

Go to main page

Versions in this module

v0

v0.14.0

Oct 14, 2026

v0.13.0

Oct 2, 2026

v0.12.0

Sep 12, 2026

v0.11.0

Sep 3, 2026

Changes in this version

type BuildStep

+ Secrets map[string]string

v0.10.0

Aug 30, 2026

Changes in this version

type BuildConfig

+ RootDir string

v0.9.2

Aug 24, 2026

v0.9.1

Aug 24, 2026

Changes in this version

+ const LabelDescription

+ func WithDescription(labels map[string]string, description string) map[string]string

v0.9.0

Aug 19, 2026

Changes in this version

+ func ResolveImageStamp(rootDir string, cfg *config.Config) (imageVersion, commit string)

v0.8.0

Aug 4, 2026

Changes in this version

+ func DetectVersionLenient(rootDir string, cfg *config.Config) (*gitver.VersionInfo, error)

+ func HasVersionScheme(cfg *config.Config) bool

+ func HashBuildContext(dockerfile, contextDir string) string

+ func ScribeRenderSlots(order []PerformNode) (first []string, after map[string][]string)

type BuildStep

+ ContextDigest string

+ type PerformNode struct

+ Build *config.BuildConfig

+ ScribeID string

+ func PerformOrder(builds []config.BuildConfig, stencils config.OrderedStencils) ([]PerformNode, error)

+ func (n PerformNode) IsScribe() bool

v0.7.0

Jul 11, 2026

Changes in this version

+ const DistDir

+ const ProvenanceDir

+ func DefaultTestCommand(builder, fromDir, rootDir string) (args []string, workdir string, err error)

+ func ExtractPredicate(statementPath string) (predPath, statementSHA string, ok bool)

+ func FindBuildProvenance(rootDir string) ([]string, error)

+ func StepIDForTarget(buildID string, t Target) string

type ArchiveOpts

+ Target Target

type BuildConfig

+ Image string

type BuildStep

+ SkippedTargets []TargetSkip

+ type CargoBuild struct

+ Stderr io.Writer

+ Stdout io.Writer

+ Verbose bool

+ func NewCargoBuild(verbose bool) *CargoBuild

+ func (c *CargoBuild) Build(ctx context.Context, opts CargoBuildOpts) (*CargoBuildResult, error)

+ type CargoBuildOpts struct

+ Args []string

+ BinName string

+ CargoBin string

+ Env map[string]string

+ ManifestDir string

+ OutputPath string

+ Release bool

+ TargetDir string

+ type CargoBuildResult struct

+ Path string

+ SHA256 string

+ Size int64

type RegistryTarget

+ SigningProfile *config.ResolvedSigningProfile

type ResultsBuilder

+ func ResultsBuilderFromManifest(m *artifact.ResultsManifest) *ResultsBuilder

+ type Target struct

+ ABI string

+ Arch string

+ Libc string

+ OS string

+ func ParseTarget(s string) Target

+ func ParseTargets(ss []string) []Target

+ func (t Target) Slug() string

+ func (t Target) String() string

+ type TargetSkip struct

+ Reason string

+ TargetID string

type UniversalStep

+ Target Target

v0.6.1

Jun 5, 2026

Changes in this version

type GoBuildOpts

+ GoBin string

v0.6.0

Jun 4, 2026

Changes in this version

+ func PlanToOutputs(plan *BuildPlan, opts PlanToOutputsOpts) (artifact.OutputsManifest, error)

+ type ArchiveArtifactPlan struct

+ Format string

+ Name string

+ Path string

+ Version string

+ type BinaryArtifactPlan struct

+ Arch string

+ Name string

+ OS string

+ Path string

+ Toolchain string

+ Version string

type BuildStep

+ OCILayoutDir string

+ type PlanToOutputsOpts struct

+ ArchivePlans []ArchiveArtifactPlan

+ BinaryPlans []BinaryArtifactPlan

+ Commit string

+ GeneratedAt string

+ Pipeline *artifact.Pipeline

+ type PushObservation struct

+ Digest string

+ Host string

+ Path string

+ Tag string

+ type ResultsBuilder struct

+ func NewResultsBuilder() *ResultsBuilder

+ func (b *ResultsBuilder) Build(outputs *artifact.OutputsManifest) (artifact.ResultsManifest, error)

+ func (b *ResultsBuilder) Record(artifactID artifact.ArtifactID, o artifact.Outcome)

type StepResult

+ Publications []PushObservation

v0.5.0

Apr 4, 2026

Changes in this version

type BuildStep

+ CacheFrom []CacheRef

+ CacheTo []CacheRef

+ type CacheRef struct

+ Direction string

+ Mode string

+ Ref string

+ Type string

+ func (c CacheRef) Flag() string

type StepResult

+ PublishedImages []artifact.PublishedImage

v0.4.1

Mar 27, 2026

v0.4.0

Mar 22, 2026

Changes in this version

+ func AllV2() []string

+ func BuildOrder(builds []config.BuildConfig) ([]config.BuildConfig, error)

+ func ChecksumFile(path string) (string, error)

+ func RegisterV2(name string, constructor func() EngineV2)

+ func StepIDForPlatform(buildID string, p Platform) string

+ func ValidateBuildGraph(steps []UniversalStep) error

+ func WriteChecksums(outputDir string, archives []*ArchiveResult) (string, error)

+ type ArchiveOpts struct

+ BinaryName string

+ BinaryPath string

+ BuildID string

+ Format string

+ IncludeFiles []string

+ NameTemplate string

+ OutputDir string

+ Platform Platform

+ RepoRoot string

+ Version *VersionInfo

+ type ArchiveResult struct

+ Contents []string

+ Format string

+ Path string

+ SHA256 string

+ Size int64

+ func CreateArchive(opts ArchiveOpts) (*ArchiveResult, error)

+ type ArtifactRef struct

+ Path string

+ Type string

+ type BuildConfig struct

+ Args []string

+ BuildArgs map[string]string

+ BuildMode string

+ Builder string

+ Command string

+ Compress bool

+ Context string

+ DependsOn string

+ Dockerfile string

+ Env map[string]string

+ From string

+ ID string

+ Kind string

+ Output string

+ Platforms []Platform

+ Registries []RegistryTarget

+ SelectTags []string

+ Tags []string

+ Target string

+ Version *VersionInfo

+ type Capabilities struct

+ ProducesArchives bool

+ ProducesOCI bool

+ SupportsCrossCompile bool

+ SupportsCrucible bool

type Detection

+ MainPackages []string

+ type EngineV2 interface

+ Capabilities func() Capabilities

+ Detect func(ctx context.Context, rootDir string) (*Detection, error)

+ ExecuteStep func(ctx context.Context, step UniversalStep) (*UniversalStepResult, error)

+ Name func() string

+ Plan func(ctx context.Context, cfg BuildConfig) ([]UniversalStep, error)

+ func GetV2(name string) (EngineV2, error)

+ type GoBuild struct

+ Stderr io.Writer

+ Stdout io.Writer

+ Verbose bool

+ func NewGoBuild(verbose bool) *GoBuild

+ func (g *GoBuild) Build(ctx context.Context, opts GoBuildOpts) (*GoBuildResult, error)

+ func (g *GoBuild) DetectMainPackages(rootDir string) ([]string, error)

+ func (g *GoBuild) ToolchainVersion(ctx context.Context) (string, error)

+ type GoBuildOpts struct

+ Args []string

+ Entry string

+ Env map[string]string

+ GOARCH string

+ GOOS string

+ OutputPath string

+ type GoBuildResult struct

+ Path string

+ SHA256 string

+ Size int64

+ type ImagePlanInput struct

+ BuildID string

+ Cfg *config.Config

+ type Platform struct

+ Arch string

+ OS string

+ func ParsePlatform(s string) Platform

+ func ParsePlatforms(ss []string) []Platform

+ func (p Platform) String() string

+ type ProducedArtifact struct

+ Path string

+ SHA256 string

+ Size int64

+ Type string

type RegistryTarget

+ NativeScan bool

+ type StepMeta interface

+ StepMetaKind func() string

+ type StepMetrics struct

+ Cached bool

+ Duration time.Duration

+ type UniversalStep struct

+ BuildID string

+ Engine string

+ Inputs []ArtifactRef

+ Meta StepMeta

+ Outputs []ArtifactRef

+ Platform Platform

+ StepID string

+ func (s UniversalStep) MarshalJSON() ([]byte, error)

+ type UniversalStepResult struct

+ Artifacts []ProducedArtifact

+ Metadata map[string]string

+ Metrics StepMetrics

v0.3.2

Mar 16, 2026

Changes in this version

+ func SlugifyBuildID(id string) string

+ type ArgDecl struct

+ Default string

+ Line string

+ Name string

+ type InventoryResult struct

+ Args []ArgDecl

+ BaseImages []PackageInfo

+ Lineage []PackageInfo

+ Packages []PackageInfo

+ func ExtractInventory(dockerfilePath string) (*InventoryResult, error)

+ type PackageInfo struct

+ Confidence string

+ Final bool

+ Manager string

+ Name string

+ Pinned bool

+ Source string

+ SourceRef string

+ Stage string

+ URL string

+ Version string

v0.3.1

Mar 13, 2026

v0.3.0

Mar 13, 2026

Changes in this version

+ const CrucibleAllowEnvVar

+ const CrucibleEnvVar

+ const CrucibleRunIDEnvVar

+ const LabelBuildMode

+ const LabelCreated

+ const LabelPlanHash

+ const LabelRevision

+ const LabelVersion

+ const PublishManifestPath

+ const StageFreightModule

+ const TrustConsistent

+ const TrustDeterministic

+ const TrustReproducible

+ const TrustViable

+ var ErrPublishManifestInvalid = errors.New("publish manifest invalid")

+ var ErrPublishManifestNotFound = errors.New("publish manifest not found")

+ func All() []string

+ func CleanupCrucibleImages(ctx context.Context, tags ...string) error

+ func CosignAttest(ctx context.Context, digestRef, predicatePath, keyPath string) error

+ func CosignAvailable() bool

+ func CosignSign(ctx context.Context, digestRef, keyPath string, multiArch bool) error

+ func CrucibleTag(purpose, runID string) string

+ func DetectProvider(registryURL string) string

+ func DetectVersion(rootDir string) (*gitver.VersionInfo, error)

+ func EnsureCrucibleAllowed(rootDir string) error

+ func EnvFingerprint() string

+ func FormatLayerInstruction(e LayerEvent) string

+ func FormatLayerTiming(e LayerEvent) string

+ func GenerateCrucibleRunID() string

+ func ImageBinaryHash(ctx context.Context, image string) (string, error)

+ func ImageDigest(ctx context.Context, image string) (string, error)

+ func ImageEnvFingerprint(ctx context.Context, image string) (string, error)

+ func ImageLabel(ctx context.Context, image, label string) (string, error)

+ func ImageVersion(ctx context.Context, image string) (string, error)

+ func InjectLabels(plan *BuildPlan, labels map[string]string)

+ func IsCrucibleChild() bool

+ func IsMultiPlatform(step BuildStep) bool

+ func NormalizeBuildPlan(plan *BuildPlan) string

+ func ParseMetadataDigest(metadataFile string) (string, error)

+ func Register(name string, constructor func() Engine)

+ func ResolveCosignKey() string

+ func ResolveDigest(ctx context.Context, ref string) (string, error)

+ func ResolveLocalDigest(ctx context.Context, ref string) (string, error)

+ func ResolveTags(templates []string, v *gitver.VersionInfo) []string

+ func ResolveTemplate(tmpl string, v *gitver.VersionInfo) string

+ func StandardLabels(planHash, sfVersion, commit, mode, createdRFC3339 string) map[string]string

+ func TruncHash(s string) string

+ func TrustLevelLabel(level string) string

+ func WriteDSSEProvenance(path string, stmt ProvenanceStatement) error

+ func WriteProvenance(path string, stmt ProvenanceStatement) error

+ func WritePublishManifest(dir string, manifest PublishManifest) error

+ type AttestationRecord struct

+ AttestationRef string

+ SignatureRef string

+ SignerIdentity string

+ Type AttestationType

+ VerifiedDigest string

+ type AttestationType string

+ const AttestationCosign

+ const AttestationInToto

+ const AttestationSLSA

+ type BuildInstance struct

+ Commit string

+ CreatedAt string

+ JobID string

+ PipelineID string

+ type BuildPlan struct

+ Steps []BuildStep

+ type BuildResult struct

+ Duration time.Duration

+ Steps []StepResult

+ type BuildStep struct

+ BuildArgs map[string]string

+ Context string

+ Dockerfile string

+ Extract []ExtractRule

+ Labels map[string]string

+ Load bool

+ MetadataFile string

+ Name string

+ Output OutputMode

+ Platforms []string

+ Push bool

+ Registries []RegistryTarget

+ SavePath string

+ Tags []string

+ Target string

+ type Buildx struct

+ Stderr io.Writer

+ Stdout io.Writer

+ Verbose bool

+ func NewBuildx(verbose bool) *Buildx

+ func (bx *Buildx) Build(ctx context.Context, step BuildStep) (*StepResult, error)

+ func (bx *Buildx) BuildWithLayers(ctx context.Context, step BuildStep) (*StepResult, []LayerEvent, error)

+ func (bx *Buildx) EnsureBuilder(ctx context.Context) error

+ func (bx *Buildx) Login(ctx context.Context, registries []RegistryTarget) error

+ func (bx *Buildx) PushTags(ctx context.Context, tags []string) error

+ func (bx *Buildx) Save(ctx context.Context, imageRef string, outputPath string) error

+ type CrucibleCheck struct

+ Detail string

+ Name string

+ Status string

+ func (c CrucibleCheck) IsHardFailure() bool

+ type CrucibleOpts struct

+ EnvVars []string

+ ExtraFlags []string

+ FinalTag string

+ Image string

+ RepoDir string

+ RunID string

+ Verbose bool

+ type CrucibleResult struct

+ ExitCode int

+ FinalImageRef string

+ Passed bool

+ func RunCrucible(ctx context.Context, opts CrucibleOpts) (*CrucibleResult, error)

+ type CrucibleVerification struct

+ ArtifactChecks []CrucibleCheck

+ ExecutionChecks []CrucibleCheck

+ TrustLevel string

+ func VerifyCrucible(ctx context.Context, pass1Image, pass2Image string) (*CrucibleVerification, error)

+ func (cv *CrucibleVerification) HasHardFailure() bool

+ type DSSEEnvelope struct

+ Payload string

+ PayloadType string

+ Signatures []DSSESignature

+ func WrapDSSE(stmt ProvenanceStatement) (DSSEEnvelope, error)

+ type DSSESignature struct

+ KeyID string

+ Sig string

+ type Detection struct

+ Dockerfiles []DockerfileInfo

+ GitInfo *GitInfo

+ Language string

+ Lockfiles []string

+ RootDir string

+ func DetectRepo(rootDir string) (*Detection, error)

+ type DockerfileInfo struct

+ Args []string

+ Expose []string

+ Healthcheck *string

+ Path string

+ Stages []Stage

+ func ParseDockerfile(path string) (*DockerfileInfo, error)

+ type Engine interface

+ Detect func(ctx context.Context, rootDir string) (*Detection, error)

+ Execute func(ctx context.Context, plan *BuildPlan) (*BuildResult, error)

+ Name func() string

+ Plan func(ctx context.Context, cfg interface{}, det *Detection) (*BuildPlan, error)

+ func Get(name string) (Engine, error)

+ type ExtractRule struct

+ From string

+ To string

+ type GitInfo struct

+ Branch string

+ LatestTag string

+ Remote string

+ SHA string

+ type LayerEvent struct

+ Cached bool

+ Detail string

+ Duration time.Duration

+ Image string

+ Instruction string

+ Stage string

+ StageStep string

+ func ParseBuildxOutput(output string) []LayerEvent

+ type OutputMode string

+ const OutputImage

+ const OutputLocal

+ const OutputTar

+ type ProvenanceBuilder struct

+ ID string

+ type ProvenanceInvocation struct

+ ConfigSource map[string]any

+ Environment map[string]any

+ Parameters map[string]any

+ type ProvenanceMaterial struct

+ Digest map[string]string

+ URI string

+ type ProvenanceMetadata struct

+ BuildFinishedOn string

+ BuildStartedOn string

+ Completeness map[string]bool

+ Reproducible bool

+ type ProvenancePredicate struct

+ BuildType string

+ Builder ProvenanceBuilder

+ Invocation ProvenanceInvocation

+ Materials []ProvenanceMaterial

+ Metadata ProvenanceMetadata

+ StageFreight map[string]any

+ type ProvenanceStatement struct

+ Predicate ProvenancePredicate

+ PredicateType string

+ Subject []ProvenanceSubject

+ Type string

+ type ProvenanceSubject struct

+ Digest map[string]string

+ Name string

+ type PublishManifest struct

+ Published []PublishedImage

+ Timestamp string

+ func ReadPublishManifest(dir string) (*PublishManifest, error)

+ type PublishedImage struct

+ Attestation *AttestationRecord

+ BuildInstance BuildInstance

+ CredentialRef string

+ Digest string

+ ExpectedCommit string

+ ExpectedTags []string

+ Host string

+ ObservedBy string

+ ObservedByAlt string

+ ObservedDigest string

+ ObservedDigestAlt string

+ Path string

+ Provider string

+ Ref string

+ Registry string

+ SigningAttempted bool

+ Tag string

+ type RegistryTarget struct

+ Credentials string

+ Path string

+ Provider string

+ Retention config.RetentionPolicy

+ TagPatterns []string

+ Tags []string

+ URL string

+ type Stage struct

+ BaseImage string

+ Line int

+ Name string

+ type StepResult struct

+ Artifacts []string

+ Duration time.Duration

+ Error error

+ Images []string

+ Layers []LayerEvent

+ Name string

+ Status string

+ type VerificationArtifact struct

+ Tag string

+ func (va VerificationArtifact) AppendFlags() []string

+ type VersionInfo = gitver.VersionInfo

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