Documentation
¶
Overview ¶
Package bundle provides CLI commands for inspecting, verifying, and extracting solution bundles built by 'scafctl build solution'.
Index ¶
- func CommandBundle(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func CommandDiff(cliParams *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandExtract(cliParams *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandVerify(cliParams *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- type DiffOptions
- type DiffResult
- type DiffSets
- type ExtractOptions
- type FileDiffEntry
- type FilesDiff
- type PluginDiffEntry
- type PluginsDiff
- type SolutionDiff
- type VendoredDiff
- type VendoredEntry
- type VendoredUpgrade
- type VerifyOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CommandBundle ¶
func CommandBundle(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
CommandBundle creates the bundle command group.
func CommandDiff ¶
CommandDiff creates the bundle diff command.
Types ¶
type DiffOptions ¶
type DiffOptions struct {
RefA string
RefB string
FilesOnly bool
SolutionOnly bool
Ignore []string
CliParams *settings.Run
IOStreams *terminal.IOStreams
flags.KvxOutputFlags
}
DiffOptions holds options for the bundle diff command.
type DiffResult ¶
type DiffResult struct {
RefA string `json:"refA" yaml:"refA"`
RefB string `json:"refB" yaml:"refB"`
Solution *SolutionDiff `json:"solution,omitempty" yaml:"solution,omitempty"`
Files *FilesDiff `json:"files,omitempty" yaml:"files,omitempty"`
Vendored *VendoredDiff `json:"vendoredDependencies,omitempty" yaml:"vendoredDependencies,omitempty"`
Plugins *PluginsDiff `json:"plugins,omitempty" yaml:"plugins,omitempty"`
}
DiffResult is the structured output of a bundle diff.
type DiffSets ¶
type DiffSets struct {
Added []string `json:"added,omitempty" yaml:"added,omitempty"`
Removed []string `json:"removed,omitempty" yaml:"removed,omitempty"`
Modified []string `json:"modified,omitempty" yaml:"modified,omitempty"`
}
DiffSets contains added/removed/modified name lists.
type ExtractOptions ¶
type ExtractOptions struct {
ArtifactRef string
OutputDir string
Resolvers []string
Actions []string
Include []string
ListOnly bool
Flatten bool
CliParams *settings.Run
IOStreams *terminal.IOStreams
}
ExtractOptions holds options for the bundle extract command.
type FileDiffEntry ¶
type FileDiffEntry struct {
Path string `json:"path" yaml:"path"`
Size int64 `json:"size,omitempty" yaml:"size,omitempty"`
}
FileDiffEntry describes a changed file.
type FilesDiff ¶
type FilesDiff struct {
Added []FileDiffEntry `json:"added,omitempty" yaml:"added,omitempty"`
Removed []FileDiffEntry `json:"removed,omitempty" yaml:"removed,omitempty"`
Modified []FileDiffEntry `json:"modified,omitempty" yaml:"modified,omitempty"`
}
FilesDiff holds changes to bundled files.
type PluginDiffEntry ¶
type PluginDiffEntry struct {
Name string `json:"name" yaml:"name"`
VersionFrom string `json:"versionFrom,omitempty" yaml:"versionFrom,omitempty"`
VersionTo string `json:"versionTo,omitempty" yaml:"versionTo,omitempty"`
}
PluginDiffEntry describes a plugin change.
type PluginsDiff ¶
type PluginsDiff struct {
Added []PluginDiffEntry `json:"added,omitempty" yaml:"added,omitempty"`
Removed []PluginDiffEntry `json:"removed,omitempty" yaml:"removed,omitempty"`
Modified []PluginDiffEntry `json:"modified,omitempty" yaml:"modified,omitempty"`
}
PluginsDiff lists plugin dependency changes.
type SolutionDiff ¶
type SolutionDiff struct {
Resolvers DiffSets `json:"resolvers,omitempty" yaml:"resolvers,omitempty"`
Actions DiffSets `json:"actions,omitempty" yaml:"actions,omitempty"`
}
SolutionDiff holds changes to the solution structure.
type VendoredDiff ¶
type VendoredDiff struct {
Added []VendoredEntry `json:"added,omitempty" yaml:"added,omitempty"`
Removed []VendoredEntry `json:"removed,omitempty" yaml:"removed,omitempty"`
Upgraded []VendoredUpgrade `json:"upgraded,omitempty" yaml:"upgraded,omitempty"`
}
VendoredDiff lists vendored dependency changes.
type VendoredEntry ¶
type VendoredEntry struct {
Name string `json:"name" yaml:"name"`
Version string `json:"version,omitempty" yaml:"version,omitempty"`
}
VendoredEntry describes a vendored dependency.
type VendoredUpgrade ¶
type VendoredUpgrade struct {
Name string `json:"name" yaml:"name"`
From string `json:"from" yaml:"from"`
To string `json:"to" yaml:"to"`
}
VendoredUpgrade describes a vendored dependency version change.