Documentation
¶
Overview ¶
Package github provides the GitHub Actions plugin for TerraCi. It registers a pipeline generator and PR comment service.
Index ¶
- Variables
- type Client
- type Concurrency
- type Config
- type ConfigStep
- type Container
- type Generator
- type Image
- type Job
- type JobDefaults
- type JobOverwrite
- type JobOverwriteType
- type MRCommentConfig
- type PRConfig
- type PRContext
- type PRService
- type PRTrigger
- 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
- type PushTrigger
- type Step
- type SummaryJobConfig
- type Workflow
- type WorkflowTrigger
Constants ¶
This section is empty.
Variables ¶
var ( SummaryJobName = githubci.SummaryJobName OverwriteTypePlan = githubci.OverwriteTypePlan OverwriteTypeApply = githubci.OverwriteTypeApply )
Re-export constants from internal package.
var ( NewGenerator = githubci.NewGenerator NewClient = githubci.NewClient NewClientFromEnv = githubci.NewClientFromEnv DetectPRContext = githubci.DetectPRContext NewPRService = githubci.NewPRService NewPRServiceFromEnv = githubci.NewPRServiceFromEnv )
Re-export functions from internal package.
Functions ¶
This section is empty.
Types ¶
type Concurrency ¶
type Concurrency = githubci.Concurrency
Re-export types from internal package for external consumers.
type ConfigStep ¶
type ConfigStep = githubci.ConfigStep
Re-export types from internal package for external consumers.
type JobDefaults ¶
type JobDefaults = githubci.JobDefaults
Re-export types from internal package for external consumers.
type JobOverwrite ¶
type JobOverwrite = githubci.JobOverwrite
Re-export types from internal package for external consumers.
type JobOverwriteType ¶
type JobOverwriteType = githubci.JobOverwriteType
Re-export types from internal package for external consumers.
type MRCommentConfig ¶
type MRCommentConfig = githubci.MRCommentConfig
Re-export types from internal package for external consumers.
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
func (*Plugin) Description ¶
func (*Plugin) InitGroup ¶
func (p *Plugin) InitGroup() *plugin.InitGroupSpec
func (*Plugin) Initialize ¶
func (*Plugin) IsConfigured ¶
func (*Plugin) NewCommentService ¶
func (p *Plugin) NewCommentService(_ *plugin.AppContext) ci.CommentService
func (*Plugin) NewGenerator ¶
func (p *Plugin) NewGenerator(_ *plugin.AppContext, depGraph *graph.DependencyGraph, modules []*discovery.Module) pipeline.Generator
func (*Plugin) ProviderName ¶
type PushTrigger ¶
type PushTrigger = githubci.PushTrigger
Re-export types from internal package for external consumers.
type SummaryJobConfig ¶
type SummaryJobConfig = githubci.SummaryJobConfig
Re-export types from internal package for external consumers.
type WorkflowTrigger ¶
type WorkflowTrigger = githubci.WorkflowTrigger
Re-export types from internal package for external consumers.
Source Files
Directories