Documentation
¶
Index ¶
- Constants
- func DeepEqual(x, y interface{}) bool
- func NewSimpleFileMatcher(paths ...string) (fileMatcher, error)
- type BuildDetails
- type BuildReason
- type BuildStatus
- type Cmd
- type CompositePathMatcher
- type CompositePatternMatcher
- type DCInfo
- type DockerBuildArgs
- type DockerInfo
- type Dockerignore
- type FastBuild
- type K8sInfo
- type LocalGithubRepo
- type Manifest
- func (m Manifest) DCInfo() DCInfo
- func (m Manifest) Dependencies() []string
- func (m Manifest) Dockerignores() []Dockerignore
- func (m1 Manifest) Equal(m2 Manifest) bool
- func (m Manifest) FastBuildInfo() FastBuild
- func (m Manifest) IsDC() bool
- func (m Manifest) IsFastBuild() bool
- func (m Manifest) IsK8s() bool
- func (m Manifest) IsStaticBuild() bool
- func (m Manifest) K8sInfo() K8sInfo
- func (m Manifest) LocalPaths() []string
- func (m Manifest) LocalRepos() []LocalGithubRepo
- func (m Manifest) ManifestName() ManifestName
- func (m Manifest) StaticBuildInfo() StaticBuild
- func (m Manifest) TiltFilename() string
- func (m Manifest) Validate() error
- func (m Manifest) ValidateDockerK8sManifest() error
- func (m Manifest) WithConfigFiles(confFiles []string) Manifest
- func (m Manifest) WithDeployInfo(info deployInfo) Manifest
- func (m Manifest) WithDockerignores(dockerignores []Dockerignore) Manifest
- func (m Manifest) WithRepos(repos []LocalGithubRepo) Manifest
- func (m Manifest) WithTiltFilename(f string) Manifest
- type ManifestName
- type Mount
- type PathMatcher
- type PatternMatcher
- type PortForward
- type StaticBuild
- type Step
- type TriggerMode
- type YAMLManifest
Constants ¶
View Source
const BuildHistoryLimit = 2
View Source
const BuildReasonNone = BuildReason(0)
View Source
const GlobalYAMLManifestName = ManifestName("k8s_yaml")
TODO(maia): throw an error if you try to name a manifest this in your Tiltfile?
Variables ¶
This section is empty.
Functions ¶
func NewSimpleFileMatcher ¶
Types ¶
type BuildDetails ¶ added in v0.4.1
type BuildDetails interface {
// contains filtered or unexported methods
}
type BuildReason ¶ added in v0.2.0
type BuildReason int
const ( BuildReasonFlagMountFiles BuildReason = 1 << iota BuildReasonFlagConfig // See comments on NeedsRebuildFromCrash BuildReasonFlagCrash BuildReasonFlagInit )
func (BuildReason) Has ¶ added in v0.2.0
func (r BuildReason) Has(flag BuildReason) bool
func (BuildReason) IsCrashOnly ¶ added in v0.2.0
func (r BuildReason) IsCrashOnly() bool
func (BuildReason) With ¶ added in v0.2.0
func (r BuildReason) With(flag BuildReason) BuildReason
type BuildStatus ¶ added in v0.4.1
type BuildStatus struct {
Edits []string
Error error
StartTime time.Time
FinishTime time.Time // IsZero() == true for in-progress builds
Reason BuildReason
Log []byte `testdiff:"ignore"`
}
func (BuildStatus) Duration ¶ added in v0.4.1
func (bs BuildStatus) Duration() time.Duration
func (BuildStatus) Empty ¶ added in v0.4.1
func (bs BuildStatus) Empty() bool
type Cmd ¶
type Cmd struct {
Argv []string
}
func ToShellCmd ¶
func ToShellCmds ¶
func (Cmd) EntrypointStr ¶
func (Cmd) IsShellStandardForm ¶
func (Cmd) ShellStandardScript ¶
Get the script when the shell is in standard form. Panics if the command is not in shell standard form.
type CompositePathMatcher ¶
type CompositePathMatcher struct {
Matchers []PathMatcher
}
type CompositePatternMatcher ¶
type CompositePatternMatcher struct {
CompositePathMatcher
Matchers []PatternMatcher
}
func (CompositePatternMatcher) AsMatchPatterns ¶
func (c CompositePatternMatcher) AsMatchPatterns() []string
type DockerBuildArgs ¶ added in v0.2.0
type DockerInfo ¶ added in v0.4.1
type DockerInfo struct {
Ref reference.Named
BuildDetails BuildDetails
// contains filtered or unexported fields
}
func (DockerInfo) CachePaths ¶ added in v0.4.1
func (di DockerInfo) CachePaths() []string
func (DockerInfo) WithBuildDetails ¶ added in v0.4.1
func (di DockerInfo) WithBuildDetails(details BuildDetails) DockerInfo
func (DockerInfo) WithCachePaths ¶ added in v0.4.1
func (di DockerInfo) WithCachePaths(paths []string) DockerInfo
type Dockerignore ¶ added in v0.4.1
type K8sInfo ¶ added in v0.4.1
type K8sInfo struct {
YAML string
PortForwards []PortForward
}
func (K8sInfo) AppendYAML ¶ added in v0.4.1
type LocalGithubRepo ¶
func (LocalGithubRepo) IsRepo ¶
func (LocalGithubRepo) IsRepo()
type Manifest ¶
type Manifest struct {
// Properties for all manifests.
Name ManifestName
// Info needed to Docker build an image. (This struct contains details of StaticBuild, FastBuild... etc.)
// (If we ever support multiple build engines, this can become an interface wildcard similar to `deployInfo`).
DockerInfo DockerInfo
// contains filtered or unexported fields
}
NOTE: If you modify Manifest, make sure to modify `Manifest.Equal` appropriately
func (Manifest) Dependencies ¶ added in v0.1.0
func (Manifest) Dockerignores ¶ added in v0.4.1
func (m Manifest) Dockerignores() []Dockerignore
func (Manifest) FastBuildInfo ¶ added in v0.4.1
func (Manifest) IsFastBuild ¶ added in v0.4.1
func (Manifest) IsStaticBuild ¶
func (Manifest) LocalPaths ¶
func (Manifest) LocalRepos ¶ added in v0.1.0
func (m Manifest) LocalRepos() []LocalGithubRepo
func (Manifest) ManifestName ¶ added in v0.1.0
func (m Manifest) ManifestName() ManifestName
func (Manifest) StaticBuildInfo ¶ added in v0.4.1
func (m Manifest) StaticBuildInfo() StaticBuild
func (Manifest) TiltFilename ¶
func (Manifest) ValidateDockerK8sManifest ¶ added in v0.4.1
ValidateDockerK8sManifest indicates whether this manifest is a valid Docker-buildable & k8s-deployable manifest.
func (Manifest) WithConfigFiles ¶ added in v0.1.0
func (Manifest) WithDeployInfo ¶ added in v0.4.1
func (Manifest) WithDockerignores ¶ added in v0.4.1
func (m Manifest) WithDockerignores(dockerignores []Dockerignore) Manifest
func (Manifest) WithRepos ¶ added in v0.4.1
func (m Manifest) WithRepos(repos []LocalGithubRepo) Manifest
func (Manifest) WithTiltFilename ¶ added in v0.1.0
type ManifestName ¶
type ManifestName string
func (ManifestName) String ¶
func (m ManifestName) String() string
type PathMatcher ¶
var EmptyMatcher PathMatcher = emptyMatcher{}
func NewCompositeMatcher ¶
func NewCompositeMatcher(matchers []PathMatcher) PathMatcher
func NewGlobMatcher ¶ added in v0.1.0
func NewGlobMatcher(globs ...string) PathMatcher
type PatternMatcher ¶
type PatternMatcher interface {
PathMatcher
// Express this PathMatcher as a sequence of filepath.Match
// patterns. These patterns are widely useful in Docker-land because
// they're suitable in .dockerignore or Dockerfile ADD statements
// https://docs.docker.com/engine/reference/builder/#add
AsMatchPatterns() []string
}
type PortForward ¶
type StaticBuild ¶ added in v0.4.1
type StaticBuild struct {
Dockerfile string
BuildPath string // the absolute path to the files
BuildArgs DockerBuildArgs
}
func (StaticBuild) Empty ¶ added in v0.4.1
func (sb StaticBuild) Empty() bool
type Step ¶
type Step struct {
// Required. The command to run in this step.
Cmd Cmd
// Optional. If not specified, this step runs on every change.
// If specified, we only run the Cmd if the trigger matches the changed file.
Triggers []string
// Directory the Triggers are relative to
BaseDirectory string
}
func ToShellSteps ¶
type TriggerMode ¶ added in v0.4.1
type TriggerMode int
const ( TriggerAuto TriggerMode = iota TriggerManual )
type YAMLManifest ¶ added in v0.1.0
type YAMLManifest struct {
// contains filtered or unexported fields
}
func NewYAMLManifest ¶ added in v0.1.0
func NewYAMLManifest(name ManifestName, k8sYaml string, configFiles []string, resourceNames []string) YAMLManifest
func (YAMLManifest) ConfigMatcher ¶ added in v0.1.0
func (y YAMLManifest) ConfigMatcher() (PathMatcher, error)
func (YAMLManifest) Dependencies ¶ added in v0.1.0
func (y YAMLManifest) Dependencies() []string
func (YAMLManifest) Empty ¶ added in v0.4.1
func (y YAMLManifest) Empty() bool
func (YAMLManifest) K8sYAML ¶ added in v0.1.0
func (y YAMLManifest) K8sYAML() string
func (YAMLManifest) ManifestName ¶ added in v0.1.0
func (y YAMLManifest) ManifestName() ManifestName
func (YAMLManifest) Resources ¶ added in v0.4.1
func (y YAMLManifest) Resources() []string
Click to show internal directories.
Click to hide internal directories.