Documentation
¶
Overview ¶
Package summary provides the summary plugin for TerraCi.
Package summary provides the summary plugin for TerraCi. It registers a pipeline contributor and the `terraci summary` command.
Index ¶
- type Plugin
- func (p *Plugin) BuildInitConfig(state *initwiz.StateMap) (*initwiz.InitContribution, error)
- func (p *Plugin) Commands() []*cobra.Command
- func (p *Plugin) InitGroups() []*initwiz.InitGroupSpec
- func (p *Plugin) PipelineContribution(_ *plugin.AppContext) (*pipeline.Contribution, error)
- func (p *Plugin) Runtime(_ context.Context, appCtx *plugin.AppContext) (any, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct {
plugin.BasePlugin[*summaryengine.Config]
}
Plugin is the summary plugin.
func (*Plugin) BuildInitConfig ¶
BuildInitConfig builds the summary plugin config from wizard state.
func (*Plugin) InitGroups ¶ added in v0.7.5
func (p *Plugin) InitGroups() []*initwiz.InitGroupSpec
InitGroups returns the summary plugin's form group for the init wizard.
func (*Plugin) PipelineContribution ¶
func (p *Plugin) PipelineContribution(_ *plugin.AppContext) (*pipeline.Contribution, error)
PipelineContribution returns the summary job contribution for the pipeline DAG. Framework guarantees this is only called when IsEnabled() == true.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.