scanner

Documentation

Index

• func FindGitignores(root string) []string
• func JsFrameworkCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error
• func LaravelCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error
• func PhoenixCallback(appName string, _ *SourceInfo, plan *plan.LaunchPlan, flags []string) error
• func RailsCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error
• func RailsFailureCallback(err error) error
• type DatabaseKind
• type GitHubActionsStruct
• type InitCommand
• type MergeConfigStruct
• type Pipfile
• type PyApp
• type PyCfg
• type PyProjectToml
• type ScannerConfig
• type Secret
• type SourceFile
• type SourceInfo
  • func Scan(sourceDir string, config *ScannerConfig) (*SourceInfo, error)
  • func ScanDockerfile(dockerfilePath string, config *ScannerConfig) (*SourceInfo, error)
• type Static
• type Volume

Functions

func FindGitignores

func FindGitignores(root string) []string

func JsFrameworkCallback

func JsFrameworkCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error

func LaravelCallback

func LaravelCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error

func PhoenixCallback

func PhoenixCallback(appName string, _ *SourceInfo, plan *plan.LaunchPlan, flags []string) error

func RailsCallback

func RailsCallback(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error

func RailsFailureCallback

func RailsFailureCallback(err error) error

Types

type DatabaseKind

type DatabaseKind int

const (
	DatabaseKindNone DatabaseKind = iota
	DatabaseKindPostgres
	DatabaseKindMySQL
	DatabaseKindSqlite
)

type GitHubActionsStruct

type GitHubActionsStruct struct {
	Deploy  bool
	Secrets bool
	Files   []SourceFile
}

type InitCommand

type InitCommand struct {
	Command     string
	Args        []string
	Description string
	Condition   bool
}

type MergeConfigStruct

type MergeConfigStruct struct {
	Name      string
	Temporary bool
}

type Pipfile

type Pipfile struct {
	Packages map[string]interface{}
}

type PyApp

type PyApp string

const (
	FastAPI   PyApp = "fastapi"
	Flask     PyApp = "flask"
	Streamlit PyApp = "streamlit"
)

type PyCfg

type PyCfg struct {
	// contains filtered or unexported fields
}

type PyProjectToml

type PyProjectToml struct {
	Project struct {
		Name           string
		Version        string
		Dependencies   []string
		RequiresPython string `toml:"requires-python"`
	}
	Tool struct {
		Poetry struct {
			Name         string
			Version      string
			Dependencies map[string]interface{}
		}
	}
}

type ScannerConfig

type ScannerConfig struct {
	Mode         string
	ExistingPort int
	Colorize     *iostreams.ColorScheme
}

type Secret

type Secret struct {
	Key      string
	Help     string
	Value    string
	Generate func() (string, error)
}

type SourceFile

type SourceFile struct {
	Path     string
	Contents []byte
}

type SourceInfo

type SourceInfo struct {
	Family                       string
	Version                      string
	DockerfilePath               string
	BuildArgs                    map[string]string
	Builder                      string
	ReleaseCmd                   string
	DockerCommand                string
	DockerEntrypoint             string
	KillSignal                   string
	SwapSizeMB                   int
	Buildpacks                   []string
	Secrets                      []Secret
	Files                        []SourceFile
	Port                         int
	Env                          map[string]string
	Statics                      []Static
	Processes                    map[string]string
	DeployDocs                   string
	Notice                       string
	SkipDeploy                   bool
	SkipDatabase                 bool
	Volumes                      []Volume
	DockerfileAppendix           []string
	InitCommands                 []InitCommand
	PostgresInitCommands         []InitCommand
	PostgresInitCommandCondition bool
	DatabaseDesired              DatabaseKind
	RedisDesired                 bool
	GitHubActions                GitHubActionsStruct
	ObjectStorageDesired         bool
	Concurrency                  map[string]int
	Callback                     func(appName string, srcInfo *SourceInfo, plan *plan.LaunchPlan, flags []string) error
	HttpCheckPath                string
	HttpCheckHeaders             map[string]string
	ConsoleCommand               string
	MergeConfig                  *MergeConfigStruct
	AutoInstrumentErrors         bool
	FailureCallback              func(err error) error
}

func Scan

func Scan(sourceDir string, config *ScannerConfig) (*SourceInfo, error)

func ScanDockerfile

func ScanDockerfile(dockerfilePath string, config *ScannerConfig) (*SourceInfo, error)

type Static

type Static = appconfig.Static

type Volume

type Volume = appconfig.Mount