Documentation
¶
Index ¶
- Constants
- func NormalizeConfigPath(configPath string) string
- type Config
- type GitRef
- type Ref
- func (ref *Ref) AsModule(ctx context.Context, c *dagger.Client) (*dagger.Module, error)
- func (ref *Ref) AsUninitializedModule(ctx context.Context, c *dagger.Client) (*dagger.Module, error)
- func (ref *Ref) Config(ctx context.Context, c *dagger.Client) (*Config, error)
- func (ref *Ref) LocalSourcePath() (string, error)
- func (ref *Ref) String() string
- func (ref *Ref) Symbolic() string
Constants ¶
View Source
const Filename = "dagger.json"
Filename is the name of the module config file.
Variables ¶
This section is empty.
Functions ¶
func NormalizeConfigPath ¶
NormalizeConfigPath appends /dagger.json to the given path if it is not already present.
Types ¶
type Config ¶
type Config struct { Name string `json:"name" field:"true" doc:"The name of the module."` Root string `` /* 127-byte string literal not displayed */ SDK string `` /* 153-byte string literal not displayed */ Include []string `json:"include,omitempty" field:"true" doc:"Include only these file globs when loading the module root."` Exclude []string `json:"exclude,omitempty" field:"true" doc:"Exclude these file globs when loading the module root."` Dependencies []string `json:"dependencies,omitempty" field:"true" doc:"Modules that this module depends on."` }
Config is the module config loaded from dagger.json.
func (*Config) RootAndSubpath ¶
func (*Config) TypeDescription ¶ added in v0.9.7
type Ref ¶
type Ref struct { Path string // Path is the provided path for the module. Version string // Version is the provided version for the module, if any. Local bool // Local indicates that the module's Path is just a local path. Git *GitRef // Git is the resolved Git information. SubPath string // Subdir is the subdirectory within the fetched source. }
Ref contains all of the information we're able to learn about a provided module ref.
func ResolveModuleDependency ¶
func ResolveMovingRef ¶
func ResolveStableRef ¶
TODO dedup with ResolveMovingRef
func (*Ref) AsUninitializedModule ¶ added in v0.9.7
func (*Ref) LocalSourcePath ¶
Click to show internal directories.
Click to hide internal directories.