Documentation ¶
Index ¶
- Constants
- Variables
- func CheckWorkspaces(artifacts []*latest.Artifact) error
- func GetBuilder(ctx context.Context, r *runcontext.RunContext, s build.ArtifactStore, ...) (build.PipelineBuilder, error)
- func GetDeployer(ctx context.Context, runCtx *runcontext.RunContext, ...) (deploy.Deployer, error)
- func WithNotification(d deploy.Deployer) deploy.Deployer
- func WithTimings(b build.Builder, t test.Tester, d deploy.Deployer, cacheArtifacts bool) (build.Builder, test.Tester, deploy.Deployer)
- type Builder
- type ChangeSet
- func (c *ChangeSet) AddRebuild(a *latest.Artifact)
- func (c *ChangeSet) AddResync(s *sync.Item)
- func (c *ChangeSet) AddRetest(a *latest.Artifact)
- func (c *ChangeSet) NeedsRebuild() []*latest.Artifact
- func (c *ChangeSet) NeedsRedeploy() bool
- func (c *ChangeSet) NeedsReload() bool
- func (c *ChangeSet) NeedsResync() []*sync.Item
- func (c *ChangeSet) NeedsRetest() map[string]bool
- func (c *ChangeSet) Redeploy()
- func (c *ChangeSet) Reload()
- func (c *ChangeSet) ResetBuild()
- func (c *ChangeSet) ResetDeploy()
- func (c *ChangeSet) ResetSync()
- func (c *ChangeSet) ResetTest()
- type Intents
- func (i *Intents) GetAutoBuild() bool
- func (i *Intents) GetAutoDeploy() bool
- func (i *Intents) GetAutoDevloop() bool
- func (i *Intents) GetAutoSync() bool
- func (i *Intents) GetIntents() (bool, bool, bool)
- func (i *Intents) GetIntentsAttrs() (bool, bool, bool)
- func (i *Intents) IsAnyAutoEnabled() bool
- func (i *Intents) Reset()
- func (i *Intents) ResetBuild()
- func (i *Intents) ResetDeploy()
- func (i *Intents) ResetSync()
- func (i *Intents) SetAutoBuild(val bool)
- func (i *Intents) SetAutoDeploy(val bool)
- func (i *Intents) SetAutoDevloop(val bool)
- func (i *Intents) SetAutoSync(val bool)
- func (i *Intents) SetBuild(val bool)
- func (i *Intents) SetDeploy(val bool)
- func (i *Intents) SetDevloop(val bool)
- func (i *Intents) SetSync(val bool)
- type Listener
- type Pruner
- type Runner
- type SkaffoldListener
Constants ¶
const ( RemoteDigestSource = "remote" NoneDigestSource = "none" TagDigestSource = "tag" )
Variables ¶
var ErrorConfigurationChanged = errors.New("configuration changed")
ErrorConfigurationChanged is a special error that's returned when the skaffold configuration was changed.
Functions ¶
func CheckWorkspaces ¶ added in v1.24.0
func GetBuilder ¶ added in v1.24.0
func GetBuilder(ctx context.Context, r *runcontext.RunContext, s build.ArtifactStore, d graph.SourceDependenciesCache, p latest.Pipeline) (build.PipelineBuilder, error)
GetBuilder creates a builder from a given RunContext and build pipeline type.
func GetDeployer ¶ added in v1.27.0
func GetDeployer(ctx context.Context, runCtx *runcontext.RunContext, labeller *label.DefaultLabeller) (deploy.Deployer, error)
GetDeployer creates a deployer from a given RunContext and deploy pipeline definitions.
func WithNotification ¶ added in v0.6.1
WithNotification creates a deployer that bips each time a deploy is done.
Types ¶
type Builder ¶ added in v1.23.0
type Builder struct { Builder build.Builder Builds []graph.Artifact // contains filtered or unexported fields }
func NewBuilder ¶ added in v1.24.0
func (*Builder) ApplyDefaultRepo ¶ added in v1.23.0
ApplyDefaultRepo applies the default repo to a given image tag.
func (*Builder) Build ¶ added in v1.23.0
func (r *Builder) Build(ctx context.Context, out io.Writer, artifacts []*latest.Artifact) ([]graph.Artifact, error)
Build builds a list of artifacts.
type ChangeSet ¶ added in v1.23.0
type ChangeSet struct {
// contains filtered or unexported fields
}
func (*ChangeSet) AddRebuild ¶ added in v1.23.0
func (*ChangeSet) NeedsRebuild ¶ added in v1.24.0
NeedsRebuild gets the value of needsRebuild, which itself is not expected to be changed outside ChangeSet
func (*ChangeSet) NeedsRedeploy ¶ added in v1.24.0
NeedsRedeploy gets the value of needsRedeploy, which itself is not expected to be changed outside ChangeSet
func (*ChangeSet) NeedsReload ¶ added in v1.24.0
NeedsReload gets the value of needsReload, which itself is not expected to be changed outside ChangeSet
func (*ChangeSet) NeedsResync ¶ added in v1.24.0
NeedsResync gets the value of needsResync, which itself is not expected to be changed outside ChangeSet
func (*ChangeSet) NeedsRetest ¶ added in v1.24.0
NeedsRetest gets the value of needsRetest, which itself is not expected to be changed outside ChangeSet
func (*ChangeSet) Redeploy ¶ added in v1.24.0
func (c *ChangeSet) Redeploy()
Redeploy marks that deploy is expected to happen.
func (*ChangeSet) Reload ¶ added in v1.24.0
func (c *ChangeSet) Reload()
Reload marks that reload is expected to happen.
func (*ChangeSet) ResetBuild ¶ added in v1.24.0
func (c *ChangeSet) ResetBuild()
func (*ChangeSet) ResetDeploy ¶ added in v1.24.0
func (c *ChangeSet) ResetDeploy()
type Intents ¶ added in v1.23.0
type Intents struct {
// contains filtered or unexported fields
}
func NewIntents ¶ added in v1.24.0
func (*Intents) GetAutoBuild ¶ added in v1.24.0
func (*Intents) GetAutoDeploy ¶ added in v1.24.0
func (*Intents) GetAutoDevloop ¶ added in v1.33.0
func (*Intents) GetAutoSync ¶ added in v1.24.0
func (*Intents) GetIntents ¶ added in v1.23.0
GetIntents returns build, sync, and deploy intents (in that order) If intent is devloop intent, all are returned true
func (*Intents) GetIntentsAttrs ¶ added in v1.24.0
GetIntentsAttrs returns the intent attributes for testing only.
func (*Intents) IsAnyAutoEnabled ¶ added in v1.23.0
func (*Intents) ResetBuild ¶ added in v1.24.0
func (i *Intents) ResetBuild()
func (*Intents) ResetDeploy ¶ added in v1.24.0
func (i *Intents) ResetDeploy()
func (*Intents) SetAutoBuild ¶ added in v1.24.0
func (*Intents) SetAutoDeploy ¶ added in v1.24.0
func (*Intents) SetAutoDevloop ¶ added in v1.33.0
func (*Intents) SetAutoSync ¶ added in v1.24.0
func (*Intents) SetDevloop ¶ added in v1.33.0
type Runner ¶ added in v0.33.0
type Runner interface { Apply(context.Context, io.Writer) error ApplyDefaultRepo(tag string) (string, error) Build(context.Context, io.Writer, []*latest.Artifact) ([]graph.Artifact, error) Cleanup(context.Context, io.Writer, bool) error Dev(context.Context, io.Writer, []*latest.Artifact) error Deploy(context.Context, io.Writer, []graph.Artifact) error DeployAndLog(context.Context, io.Writer, []graph.Artifact) error GeneratePipeline(context.Context, io.Writer, []util.VersionedConfig, []string, string) error HasBuilt() bool HasDeployed() bool Prune(context.Context, io.Writer) error Render(context.Context, io.Writer, []graph.Artifact, bool, string) error Test(context.Context, io.Writer, []graph.Artifact) error }
Runner is responsible for running the skaffold build, test and deploy config.
type SkaffoldListener ¶ added in v0.34.0
type SkaffoldListener struct { Monitor filemon.Monitor Trigger trigger.Trigger // contains filtered or unexported fields }
func NewSkaffoldListener ¶ added in v1.24.0
func NewSkaffoldListener(monitor filemon.Monitor, trigger trigger.Trigger, cache graph.SourceDependenciesCache, intentChan <-chan bool) *SkaffoldListener
func (*SkaffoldListener) LogWatchToUser ¶ added in v0.34.0
func (l *SkaffoldListener) LogWatchToUser(out io.Writer)
func (*SkaffoldListener) WatchForChanges ¶ added in v0.34.0
func (l *SkaffoldListener) WatchForChanges(ctx context.Context, out io.Writer, devLoop func() error) error
WatchForChanges listens to a trigger, and when one is received, computes file changes and conditionally runs the dev loop.