modules

Documentation

Index

• Constants
• type ModuleCodegenConfig
  • func (cfg ModuleCodegenConfig) Clone() *ModuleCodegenConfig
• type ModuleConfig
  • func (modCfg *ModuleConfig) DependencyByName(name string) (*ModuleConfigDependency, bool)
  • func (modCfg *ModuleConfig) UnmarshalJSON(data []byte) error
• type ModuleConfigDependency
  • func (depCfg *ModuleConfigDependency) UnmarshalJSON(data []byte) error
• type ModuleConfigUserFields
• type ModuleConfigView
• type ModuleConfigWithUserFields
  • func (modCfg *ModuleConfigWithUserFields) UnmarshalJSON(data []byte) error
• type SDK
  • func (sdk *SDK) UnmarshalJSON(data []byte) error

Constants

const EngineVersionLatest string = "latest"

EngineVersionLatest is replaced by the current engine.Version during module init.

const Filename = "dagger.json"

Filename is the name of the module config file.

Types

type ModuleCodegenConfig

type ModuleCodegenConfig struct {
	// Whether to automatically generate a .gitignore file for this module.
	AutomaticGitignore *bool `json:"automaticGitignore,omitempty"`
}

func (ModuleCodegenConfig) Clone

func (cfg ModuleCodegenConfig) Clone() *ModuleCodegenConfig

type ModuleConfig

type ModuleConfig struct {
	// The name of the module.
	Name string `json:"name"`

	// The version of the engine this module was last updated with.
	EngineVersion string `json:"engineVersion"`

	// The SDK this module uses
	SDK *SDK `json:"sdk,omitempty"`

	// Paths to explicitly include from the module, relative to the configuration file.
	Include []string `json:"include,omitempty"`

	// The modules this module depends on.
	Dependencies []*ModuleConfigDependency `json:"dependencies,omitempty"`

	// The path, relative to this config file, to the subdir containing the module's implementation source code.
	Source string `json:"source,omitempty"`

	// Codegen configuration for this module.
	Codegen *ModuleCodegenConfig `json:"codegen,omitempty"`

	// Paths to explicitly exclude from the module, relative to the configuration file.
	// Deprecated: Use !<pattern> in the include list instead.
	Exclude []string `json:"exclude,omitempty"`
}

ModuleConfig is the config for a single module as loaded from a dagger.json file. Only contains fields that are set/edited by dagger utilities.

func (*ModuleConfig) DependencyByName

func (modCfg *ModuleConfig) DependencyByName(name string) (*ModuleConfigDependency, bool)

func (*ModuleConfig) UnmarshalJSON

func (modCfg *ModuleConfig) UnmarshalJSON(data []byte) error

type ModuleConfigDependency

type ModuleConfigDependency struct {
	// The name to use for this dependency. By default, the same as the dependency module's name,
	// but can also be overridden to use a different name.
	Name string `json:"name"`

	// The source ref of the module dependency.
	Source string `json:"source"`

	// The pinned version of the module dependency.
	Pin string `json:"pin,omitempty"`
}

func (*ModuleConfigDependency) UnmarshalJSON

func (depCfg *ModuleConfigDependency) UnmarshalJSON(data []byte) error

type ModuleConfigUserFields

type ModuleConfigUserFields struct {
	// The self-describing json $schema
	Schema string `json:"$schema,omitempty"`
}

type ModuleConfigView

type ModuleConfigView struct {
	Name     string   `json:"name"`
	Patterns []string `json:"patterns,omitempty"`
}

type ModuleConfigWithUserFields

type ModuleConfigWithUserFields struct {
	ModuleConfigUserFields
	ModuleConfig
}

ModuleConfigWithUserFields is the config for a single module as loaded from a dagger.json file. Includes additional fields that should only be set by the user.

func (*ModuleConfigWithUserFields) UnmarshalJSON

func (modCfg *ModuleConfigWithUserFields) UnmarshalJSON(data []byte) error

type SDK

type SDK struct {
	Source string `json:"source"`
}

SDK represents the sdk field in dagger.json The source can be reference to a built-in sdk e.g. go, php, elixir or can be a reference to a git path e.g. github.com/username/reponame/sdk-name

func (*SDK) UnmarshalJSON

func (sdk *SDK) UnmarshalJSON(data []byte) error