Documentation
¶
Overview ¶
Package summary provides the summary plugin for TerraCi. It registers a pipeline contributor (PhaseFinalize) and the `terraci summary` command.
Index ¶
- type Config
- type Plugin
- func (p *Plugin) BuildInitConfig(state plugin.InitState) *plugin.InitContribution
- func (p *Plugin) Commands(ctx *plugin.AppContext) []*cobra.Command
- func (p *Plugin) ConfigKey() string
- func (p *Plugin) Description() string
- func (p *Plugin) InitGroup() *plugin.InitGroupSpec
- func (p *Plugin) IsConfigured() bool
- func (p *Plugin) Name() string
- func (p *Plugin) NewConfig() any
- func (p *Plugin) PipelineContribution() *pipeline.Contribution
- func (p *Plugin) SetConfig(cfg any) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Enabled *bool `yaml:"enabled,omitempty" json:"enabled,omitempty"`
OnChangesOnly bool `yaml:"on_changes_only,omitempty" json:"on_changes_only,omitempty"`
IncludeDetails bool `yaml:"include_details,omitempty" json:"include_details,omitempty"`
Labels []string `yaml:"labels,omitempty" json:"labels,omitempty"`
}
Config holds summary plugin settings.
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin is the summary plugin.
func (*Plugin) BuildInitConfig ¶
func (p *Plugin) BuildInitConfig(state plugin.InitState) *plugin.InitContribution
BuildInitConfig builds the summary plugin config from wizard state.
func (*Plugin) Commands ¶
func (p *Plugin) Commands(ctx *plugin.AppContext) []*cobra.Command
Commands returns the `terraci summary` command.
func (*Plugin) Description ¶
func (*Plugin) InitGroup ¶
func (p *Plugin) InitGroup() *plugin.InitGroupSpec
InitGroup returns the summary plugin's form group for the init wizard.
func (*Plugin) IsConfigured ¶
func (*Plugin) PipelineContribution ¶
func (p *Plugin) PipelineContribution() *pipeline.Contribution
PipelineContribution returns the summary job contribution.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.