gitlab package - github.com/edelwud/terraci/plugins/gitlab

Documentation ¶

Package gitlab provides the GitLab CI plugin for TerraCi. It registers a pipeline generator and MR comment service.

This section is empty.

This section is empty.

This section is empty.

type Plugin struct {
	plugin.BasePlugin[*configpkg.Config]
}

Plugin is the GitLab CI plugin.

func (p *Plugin) BuildInitConfig(state *initwiz.StateMap) *initwiz.InitContribution

BuildInitConfig builds the GitLab CI init contribution.

func (p *Plugin) CommitSHA() string

CommitSHA returns the GitLab CI commit SHA.

func (p *Plugin) DetectEnv() bool

DetectEnv returns true if running in GitLab CI.

func (p *Plugin) InitGroups() []*initwiz.InitGroupSpec

InitGroups returns the init wizard group specs for GitLab CI.

func (p *Plugin) NewCommentService(_ *plugin.AppContext) ci.CommentService

NewCommentService creates a new MR comment service.

func (p *Plugin) NewGenerator(ctx *plugin.AppContext, depGraph *graph.DependencyGraph, modules []*discovery.Module) pipeline.Generator

NewGenerator creates a new GitLab CI pipeline generator.

func (p *Plugin) PipelineID() string

PipelineID returns the GitLab CI pipeline ID.

func (p *Plugin) Preflight(_ context.Context, _ *plugin.AppContext) error

Preflight detects MR context when running inside GitLab CI.

func (p *Plugin) ProviderName() string

ProviderName returns the provider name.

func (p *Plugin) SetAutoApprove(v bool)

SetAutoApprove sets auto-approve mode directly on the typed config.

func (p *Plugin) SetPlanOnly(v bool)

SetPlanOnly sets plan-only mode directly on the typed config.