Documentation
¶
Index ¶
Constants ¶
View Source
const Filename = "dagger.json"
Filename is the name of the module config file.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ModuleConfig ¶ added in v0.9.8
type ModuleConfig struct {
// The name of the module.
Name string `json:"name,omitempty"`
// The SDK this module uses
SDK string `json:"sdk,omitempty"`
// Paths to explicitly include from the module, relative to the configuration file.
Include []string `json:"include,omitempty"`
// Paths to explicitly exclude from the module, relative to the configuration file.
Exclude []string `json:"exclude,omitempty"`
// The modules this module depends on.
Dependencies []*ModuleConfigDependency `json:"dependencies,omitempty"`
// Modules in subdirs that this config is the root for, which impacts those modules'
// root directory and possibly other global settings that propagate from the root.
RootFor []*ModuleConfigRootFor `json:"root-for,omitempty"`
// Deprecated: use Source instead, only used to identify legacy config files
Root string `json:"root,omitempty"`
}
ModuleConfig is the config for a single module as loaded from a dagger.json file.
func (*ModuleConfig) DependencyByName ¶ added in v0.9.8
func (modCfg *ModuleConfig) DependencyByName(name string) (*ModuleConfigDependency, bool)
func (*ModuleConfig) IsRootFor ¶ added in v0.9.8
func (modCfg *ModuleConfig) IsRootFor(source string) bool
func (*ModuleConfig) Validate ¶ added in v0.9.8
func (modCfg *ModuleConfig) Validate() error
type ModuleConfigDependency ¶ added in v0.9.8
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"`
}
func (*ModuleConfigDependency) UnmarshalJSON ¶ added in v0.9.8
func (depCfg *ModuleConfigDependency) UnmarshalJSON(data []byte) error
type ModuleConfigRootFor ¶ added in v0.9.8
type ModuleConfigRootFor struct {
// The path to the module that this config is the root for, relative to the configuration file.
Source string `json:"source"`
}
Click to show internal directories.
Click to hide internal directories.