Documentation
¶
Index ¶
- Constants
- func DeriveSlug(name string) string
- func EnvLookup(dir string) (configdoc.Lookup, error)
- func FindConfig(startDir, explicitPath string) (string, error)
- func FindRoot(startDir, explicitPath string) (string, error)
- func IsConfig(path string) bool
- func IsTypeScript(path string) bool
- func IsYAML(path string) bool
- func OtherConfigFiles(configPath string) []string
- func PreviewBaseDomain(previewDomain string) string
- func SharedFolder(apps []App) string
- func ValidateFolder(folder string) error
- func ValidatePreviewDomain(domain string) error
- func ValidateSlug(s string) error
- type App
- type Binding
- type BucketInline
- type Build
- type Container
- type DNS
- type Domains
- type Edge
- type FrameworkUnstatedError
- type Health
- type Hostname
- type Inline
- type Lifecycle
- type LifecycleCommand
- type NoConfigError
- type PostgresInline
- type PostgresTLS
- type Previews
- type Project
- func (p *Project) BindingsFor(tier environmentv1.Tier) []Binding
- func (p *Project) ConfiguredHostnames(tier environmentv1.Tier) []*contractv1.ConfiguredHostname
- func (p *Project) DescribeFrameworks() []string
- func (p *Project) EdgeKind() edge.Kind
- func (p *Project) EdgeSelection() *contractv1.EdgeSelection
- func (p *Project) HasJSApp() bool
- func (p *Project) HasProvider() bool
- func (p *Project) HasUnclearRootApp() bool
- func (p *Project) HostnameNames(tier environmentv1.Tier) []string
- func (p *Project) Hostnames(tier environmentv1.Tier) []Hostname
- func (p *Project) RequireProvider() (*Provider, error)
- func (p *Project) ResolveComputes(runs []string, vendor string) (*Project, error)
- func (p *Project) ResolveDeclaredComputes() (*Project, error)
- func (p *Project) UnresolvedApps() []string
- type Protection
- type Provider
- type Registry
- type Text
Constants ¶
View Source
const ( DotenvFileName = ".env" LocalDotenvFileName = ".env.local" )
View Source
const ( DefaultFileName = configStem + jsonSuffix YAMLFileName = configStem + yamlSuffix TSFileName = configStem + tsSuffix )
View Source
const DefaultLifecycleTimeout = 30 * time.Minute
Variables ¶
This section is empty.
Functions ¶
func DeriveSlug ¶
func FindConfig ¶
func IsTypeScript ¶
func OtherConfigFiles ¶
func PreviewBaseDomain ¶
func SharedFolder ¶
func ValidateFolder ¶
func ValidatePreviewDomain ¶
func ValidateSlug ¶
Types ¶
type App ¶
type App struct {
Name string
Path string
Folder string
Arch string
ProductionDomains []string
Compute provider.Compute
Framework string
Language language.Language
Languages []language.Language
Entrypoint string
FrameworkSource language.Source
Evidence string
GoModule *gomodule.Module
GoPackage string
Container *Container
BuildsWithResources bool
// contains filtered or unexported fields
}
func (App) Architecture ¶
func (App) HasLanguageManifest ¶
func (App) IsBuiltAsFunctions ¶
func (App) IsBuiltAsImage ¶
func (App) IsBuiltFromFunction ¶
type Binding ¶
type Binding struct {
Type resourcesv1.ResourceType
Name string
Tier environmentv1.Tier
External string
Inline *Inline
}
func (Binding) RecordName ¶
type BucketInline ¶
type Container ¶
type FrameworkUnstatedError ¶
func (*FrameworkUnstatedError) Error ¶
func (e *FrameworkUnstatedError) Error() string
type Inline ¶
type Inline struct {
Postgres *PostgresInline
Bucket *BucketInline
}
type Lifecycle ¶
type Lifecycle struct {
PreBuild *LifecycleCommand
}
type LifecycleCommand ¶
type LifecycleCommand struct {
Command string
App string
Path string
Previews Previews
Timeout time.Duration
}
func (LifecycleCommand) RunsIn ¶
func (c LifecycleCommand) RunsIn(env *environmentv1.Environment) bool
type NoConfigError ¶
func (NoConfigError) Error ¶
func (e NoConfigError) Error() string
func (NoConfigError) Finding ¶
func (e NoConfigError) Finding() string
func (NoConfigError) Hint ¶
func (NoConfigError) Hint() string
func (NoConfigError) Missing ¶
func (NoConfigError) Missing() prerequisite.Kind
func (NoConfigError) Remedy ¶
func (e NoConfigError) Remedy() string
type PostgresInline ¶
type PostgresTLS ¶
type Project ¶
type Project struct {
Slug string
Transforms []string
DiscoveryPaths []string
Provider *Provider
Edge *Edge
DNS *DNS
AllowDegraded []edge.Need
Apps []App
RootAppUndetected error
Bindings []Binding
Domains Domains
Registry *Registry
Lifecycle Lifecycle
Protection Protection
EnvSource envsource.Tiers
Dir string
Path string
}
func LoadOptional ¶
func NewUnconfigured ¶
func (*Project) BindingsFor ¶
func (p *Project) BindingsFor(tier environmentv1.Tier) []Binding
func (*Project) ConfiguredHostnames ¶
func (p *Project) ConfiguredHostnames(tier environmentv1.Tier) []*contractv1.ConfiguredHostname
func (*Project) DescribeFrameworks ¶
func (*Project) EdgeSelection ¶
func (p *Project) EdgeSelection() *contractv1.EdgeSelection
func (*Project) HasProvider ¶
func (*Project) HasUnclearRootApp ¶
func (*Project) HostnameNames ¶
func (p *Project) HostnameNames(tier environmentv1.Tier) []string
func (*Project) RequireProvider ¶
func (*Project) ResolveComputes ¶
func (*Project) ResolveDeclaredComputes ¶
func (*Project) UnresolvedApps ¶
type Protection ¶
func (Protection) Protects ¶
func (p Protection) Protects(tier environmentv1.Tier) bool
type Provider ¶
type Provider struct {
ID string
Options json.RawMessage
}
Click to show internal directories.
Click to hide internal directories.