dockercompose

type Args ¶

type Args map[string]string

Args is Compose's `build.args` block. It always marshals as the map form; the unmarshaler accepts both forms so a hand-written list-form entry (`args: [KEY=VAL]`) survives the round-trip.

func (a *Args) UnmarshalYAML(unmarshal func(any) error) error

type Build ¶

type Build struct {
	Context    string         `yaml:"context"`
	Dockerfile string         `yaml:"dockerfile"`
	Args       Args           `yaml:"args,omitempty"`
	Extra      map[string]any `yaml:",inline"`
}

Build describes how a service's image is built. It points at the dev or prod Dockerfile produced by the docker package, relative to Context.

Extra preserves build keys this model does not type (`target`, `labels`, ...).

func (b *Build) UnmarshalYAML(unmarshal func(any) error) error

type Compose ¶

type Compose struct {
	Services map[string]*Service `yaml:"services"`
	Volumes  map[string]*Volume  `yaml:"volumes,omitempty"`
	Extra    map[string]any      `yaml:",inline"`
}

Compose is the root document of a docker-compose file. Modern Compose no longer requires a top-level `version:` key, so it is intentionally omitted.

Extra is an inline catch-all for top-level keys this model does not type explicitly (`networks:`, `configs:`, `x-*` extensions, ...). It lets an existing compose file be re-rendered without discarding hand-written configuration.

type Dependency ¶

type Dependency struct {
	Service   string
	Condition string
}

Dependency is one entry of a service's `depends_on`. Condition is optional: when empty the dependency is emitted as a bare service name, otherwise it carries one of the Condition* startup conditions.

type DependsOn ¶

type DependsOn []Dependency

DependsOn is the ordered set of services a service depends on.

Compose accepts two syntaxes for `depends_on`, and DependsOn handles both: the short list form while every dependency is condition-less, and the long map form as soon as any dependency carries a condition.

func (d DependsOn) MarshalYAML() (any, error)

func (d *DependsOn) UnmarshalYAML(unmarshal func(any) error) error

type DockerCompose ¶

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

DockerCompose regenerates the project's docker-compose files from the services currently scaffolded under rootPath.

func New(rootPath string, usesDoppler bool, services map[string]projectcfg.ServiceConfig) *DockerCompose

func (d *DockerCompose) Initialize() error

type EnvFileEntry ¶

type EnvFileEntry struct {
	Path     string `yaml:"path"`
	Required bool   `yaml:"required"`
}

EnvFileEntry is one entry of a service's `env_file` list, in Compose's long form. `required: false` is emitted unconditionally so `docker compose down` / `logs` keep working before the secrets file has ever been fetched.

type Healthcheck ¶

type Healthcheck struct {
	Test        []string `yaml:"test"`
	Interval    string   `yaml:"interval,omitempty"`
	Timeout     string   `yaml:"timeout,omitempty"`
	Retries     int      `yaml:"retries,omitempty"`
	StartPeriod string   `yaml:"start_period,omitempty"`
}

Healthcheck is Compose's per-service health probe.

type Port ¶

type Port string

Port is a `host:container` port mapping. It always marshals as a quoted scalar — e.g. "8003:8003" — so the colon is never reinterpreted as a YAML mapping key or, by stricter YAML 1.1 parsers, as a base-60 number.

func (p Port) MarshalYAML() ([]byte, error)

type Service ¶

type Service struct {
	Build       *Build         `yaml:"build,omitempty"`
	Image       string         `yaml:"image,omitempty"`
	EnvFile     []EnvFileEntry `yaml:"env_file,omitempty"`
	Volumes     []string       `yaml:"volumes,omitempty"`
	Ports       []Port         `yaml:"ports,omitempty"`
	Environment []string       `yaml:"environment,omitempty"`
	DependsOn   DependsOn      `yaml:"depends_on,omitempty"`
	Healthcheck *Healthcheck   `yaml:"healthcheck,omitempty"`
	Extra       map[string]any `yaml:",inline"`
}

Service is a single container definition listed under `services:`.

Extra is an inline catch-all for service keys this model does not type (`image`, `command`, `restart`, `healthcheck`, ...), preserved verbatim across a regeneration.

type Volume ¶

type Volume struct {
	Driver   string         `yaml:"driver,omitempty"`
	Name     string         `yaml:"name,omitempty"`
	External bool           `yaml:"external,omitempty"`
	Extra    map[string]any `yaml:",inline"`
}

Volume is a named entry under the top-level `volumes:` key. A nil *Volume denotes a default volume and marshals to a null node — e.g. `go-module-cache:` — telling Compose to use default driver settings.

Extra preserves volume keys this model does not type (`driver_opts`, `labels`, ...).