core

package

v0.15.2 Latest Latest Go to latest Published: Dec 19, 2025 License: MIT Imports: 18 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/railwayapp/railpack

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func FormatBuildResult(br *BuildResult, options ...PrintOptions) string
func GenerateConfigFromEnvironment(env *app.Environment) *c.Config
func GenerateConfigFromFile(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions, ...) (*c.Config, error)
func GenerateConfigFromOptions(options *GenerateBuildPlanOptions) *c.Config
func GetConfig(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions, ...) (*c.Config, error)
func PrettyPrintBuildResult(buildResult *BuildResult, options ...PrintOptions)
func ValidatePlan(plan *plan.BuildPlan, app *app.App, logger *logger.Logger, ...) bool
type BuildResult
- func GenerateBuildPlan(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions) *BuildResult
type GenerateBuildPlanOptions
type PrintOptions
type ValidatePlanOptions

Constants ¶

View Source

const (
	AnsiRed           = "1"
	AnsiYellow        = "3"
	AnsiBlue          = "4"
	AnsiMagenta       = "5"
	AnsiCyan          = "6"
	AnsiWhite         = "7"
	AnsiGray          = "8"
	AnsiBrightBlue    = "12"
	AnsiBrightCyan    = "14"
	AnsiBrightWhite   = "15"
	AnsiBrightMagenta = "13"
	AnsiDarkGray      = "238"
	AnsiMediumGray    = "245"
)

Variables ¶

This section is empty.

Functions ¶

func FormatBuildResult ¶

func FormatBuildResult(br *BuildResult, options ...PrintOptions) string

func GenerateConfigFromEnvironment ¶

func GenerateConfigFromEnvironment(env *app.Environment) *c.Config

func GenerateConfigFromFile ¶

func GenerateConfigFromFile(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions, logger *logger.Logger) (*c.Config, error)

func GenerateConfigFromOptions ¶

func GenerateConfigFromOptions(options *GenerateBuildPlanOptions) *c.Config

generates a config from the CLI options

func GetConfig ¶

func GetConfig(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions, logger *logger.Logger) (*c.Config, error)

GetConfig merges the options, environment, and file config into a single config

func PrettyPrintBuildResult ¶

func PrettyPrintBuildResult(buildResult *BuildResult, options ...PrintOptions)

func ValidatePlan ¶ added in v0.0.41

func ValidatePlan(plan *plan.BuildPlan, app *app.App, logger *logger.Logger, options *ValidatePlanOptions) bool

Types ¶

type BuildResult ¶

type BuildResult struct {
	RailpackVersion   string                               `json:"railpackVersion,omitempty"`
	Plan              *plan.BuildPlan                      `json:"plan,omitempty"`
	ResolvedPackages  map[string]*resolver.ResolvedPackage `json:"resolvedPackages,omitempty"`
	Metadata          map[string]string                    `json:"metadata,omitempty"`
	DetectedProviders []string                             `json:"detectedProviders,omitempty"`
	Logs              []logger.Msg                         `json:"logs,omitempty"`
	Success           bool                                 `json:"success,omitempty"`
}

func GenerateBuildPlan ¶

func GenerateBuildPlan(app *app.App, env *app.Environment, options *GenerateBuildPlanOptions) *BuildResult

type GenerateBuildPlanOptions ¶

type GenerateBuildPlanOptions struct {
	RailpackVersion          string
	BuildCommand             string
	StartCommand             string
	PreviousVersions         map[string]string
	ConfigFilePath           string
	ErrorMissingStartCommand bool
}

type PrintOptions ¶

type PrintOptions struct {
	Metadata bool
	Version  string
}

type ValidatePlanOptions ¶ added in v0.0.41

type ValidatePlanOptions struct {
	ErrorMissingStartCommand bool
	ProviderToUse            providers.Provider
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
app
config
generate build step that installs packages defined by mise configuration, provider configuration, or user configuration	build step that installs packages defined by mise configuration, provider configuration, or user configuration
logger
mise
plan
providers
cpp
deno
dotnet
elixir
gleam
golang
java
node
php
procfile this provider is unique: it used solely to extract a start command	this provider is unique: it used solely to extract a start command
python
ruby
rust
shell
staticfile
resolver
testing

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