Documentation
¶
Overview ¶
Package github provides the GitHub Actions plugin for TerraCi. It registers a pipeline generator and PR comment service.
Index ¶
- type Plugin
- func (p *Plugin) BuildInitConfig(state plugin.InitState) *plugin.InitContribution
- func (p *Plugin) ConfigKey() string
- func (p *Plugin) Description() string
- func (p *Plugin) DetectEnv() bool
- func (p *Plugin) InitGroup() *plugin.InitGroupSpec
- func (p *Plugin) Initialize(_ context.Context, _ *plugin.AppContext) error
- func (p *Plugin) IsConfigured() bool
- func (p *Plugin) Name() string
- func (p *Plugin) NewCommentService(_ *plugin.AppContext) ci.CommentService
- func (p *Plugin) NewConfig() any
- func (p *Plugin) NewGenerator(_ *plugin.AppContext, depGraph *graph.DependencyGraph, ...) pipeline.Generator
- func (p *Plugin) ProviderName() string
- func (p *Plugin) SetConfig(cfg any) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin is the GitHub Actions plugin.
func (*Plugin) BuildInitConfig ¶
func (p *Plugin) BuildInitConfig(state plugin.InitState) *plugin.InitContribution
BuildInitConfig builds the GitHub Actions init contribution.
func (*Plugin) Description ¶
func (*Plugin) InitGroup ¶
func (p *Plugin) InitGroup() *plugin.InitGroupSpec
InitGroup returns the init wizard group spec for GitHub Actions.
func (*Plugin) Initialize ¶
Initialize detects PR context at startup.
func (*Plugin) IsConfigured ¶
IsConfigured returns whether the plugin has been configured.
func (*Plugin) NewCommentService ¶
func (p *Plugin) NewCommentService(_ *plugin.AppContext) ci.CommentService
NewCommentService creates a new PR comment service.
func (*Plugin) NewGenerator ¶
func (p *Plugin) NewGenerator(_ *plugin.AppContext, depGraph *graph.DependencyGraph, modules []*discovery.Module) pipeline.Generator
NewGenerator creates a new GitHub Actions pipeline generator.
func (*Plugin) ProviderName ¶
ProviderName returns the provider name.
Click to show internal directories.
Click to hide internal directories.