config

package
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2025 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SchemaUrl = "https://schema.railpack.com"
)

Variables

This section is empty.

Functions

func GetJsonSchema

func GetJsonSchema() *jsonschema.Schema

Types

type Config

type Config struct {
	Provider         *string                `json:"provider" jsonschema:"description=The provider to use"`
	BuildAptPackages []string               `json:"buildAptPackages,omitempty" jsonschema:"description=List of apt packages to install during the build step"`
	Steps            map[string]*StepConfig `json:"steps,omitempty" jsonschema:"description=Map of step names to step definitions"`
	Deploy           *DeployConfig          `json:"deploy,omitempty" jsonschema:"description=Deploy configuration"`
	Packages         map[string]string      `json:"packages,omitempty" jsonschema:"description=Map of package name to package version"`
	Caches           map[string]*plan.Cache `` /* 139-byte string literal not displayed */
	Secrets          []string               `` /* 132-byte string literal not displayed */
}

func EmptyConfig

func EmptyConfig() *Config

func Merge

func Merge(configs ...*Config) *Config

Merge combines multiple configs by merging their values with later configs taking precedence

func (*Config) GetOrCreateStep

func (c *Config) GetOrCreateStep(name string) *StepConfig

func (Config) JSONSchemaExtend

func (Config) JSONSchemaExtend(schema *jsonschema.Schema)

type DeployConfig added in v0.0.23

type DeployConfig struct {
	AptPackages []string          `json:"aptPackages,omitempty" jsonschema:"description=List of apt packages to include at runtime"`
	Base        *plan.Layer       `json:"base,omitempty" jsonschema:"description=The base image to use for the deploy step"`
	Inputs      []plan.Layer      `json:"inputs,omitempty" jsonschema:"description=The inputs for the deploy step"`
	StartCmd    string            `json:"startCommand,omitempty" jsonschema:"description=The command to run in the container"`
	Variables   map[string]string `` /* 166-byte string literal not displayed */
	Paths       []string          `json:"paths,omitempty" jsonschema:"description=The paths to prepend to the $PATH environment variable"`
}

type StepConfig added in v0.0.61

type StepConfig struct {
	plan.Step
	DeployOutputs []plan.Filter `` /* 161-byte string literal not displayed */
}

func (*StepConfig) UnmarshalJSON added in v0.0.61

func (s *StepConfig) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

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