api

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 31, 2025 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BuildParams

type BuildParams struct {
	ForcePull bool
}

type BuilderAPI

type BuilderAPI interface {
	Build(ctx context.Context, v Vertex, vars []Var, secretsSrc []SecretSrc, params BuildParams) error
}

type Cache

type Cache struct {
	ID   string
	Path string
}

type CacheAPI

type CacheAPI interface {
	ClearCache(ctx context.Context, params ClearParams) error
}

type ClearParams

type ClearParams struct {
	All bool
}

type Copy

type Copy struct {
	From maybe.Maybe[either.Either[*Vertex, string]]
	Src  string
	Dst  string
}

type CopyVar

type CopyVar struct {
	From maybe.Maybe[string]
	Src  string
	Dst  string
}

CopyVar is Copy instruction for var

type Image

type Image struct {
	From       string
	Dockerfile string
}

type Network

type Network struct {
	Network string // It may be Host and other docker networks
}

type Output

type Output struct {
	Artifact string
	Local    string
}

type SSH

type SSH struct{}

type Secret

type Secret struct {
	ID        string
	MountPath string
}

type SecretSrc

type SecretSrc struct {
	ID         string
	SourcePath string
}

type Stage

type Stage struct {
	From     string               // From for stage
	Platform maybe.Maybe[string]  // Platform for image
	WorkDir  string               // Working directory for stage
	Env      map[string]string    // Stage env
	Cache    []Cache              // Pluggable cache for build systems
	Copy     []Copy               // Copy local or build stages artifacts
	Network  maybe.Maybe[Network] // Network options
	SSH      maybe.Maybe[SSH]     // SSH access options
	Secrets  []Secret
	Command  maybe.Maybe[string] // Command for stage
	Output   maybe.Maybe[Output] // Output artifacts from builder
}

type Var

type Var struct {
	Name     string // Unique Var name
	From     string
	Platform maybe.Maybe[string]
	WorkDir  string
	Env      map[string]string
	Cache    []Cache
	Copy     []CopyVar
	Secrets  []Secret
	Network  maybe.Maybe[Network]
	SSH      maybe.Maybe[SSH]
	Command  string
}

type Vertex

type Vertex struct {
	Name string // Unique Vertex name

	Stage maybe.Maybe[Stage]

	From      maybe.Maybe[*Vertex] // Parent vertex
	DependsOn []Vertex
}

Jump to

Keyboard shortcuts

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