github

package

v0.9.0 Latest Latest Go to latest Published: Mar 31, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/edelwud/terraci

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github provides the GitHub Actions plugin for TerraCi. It registers a pipeline generator and PR comment service.

Index ¶

type Plugin

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Plugin ¶

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

Plugin is the GitHub Actions plugin.

func (*Plugin) BuildInitConfig ¶

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

BuildInitConfig builds the GitHub Actions init contribution.

func (*Plugin) CommitSHA ¶ added in v0.7.4

func (p *Plugin) CommitSHA() string

CommitSHA returns the GitHub Actions commit SHA.

func (*Plugin) DetectEnv ¶

func (p *Plugin) DetectEnv() bool

DetectEnv returns true if running in GitHub Actions.

func (*Plugin) InitGroups ¶ added in v0.7.5

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

InitGroups returns the init wizard group specs for GitHub Actions.

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(ctx *plugin.AppContext, depGraph *graph.DependencyGraph, modules []*discovery.Module) pipeline.Generator

NewGenerator creates a new GitHub Actions pipeline generator.

func (*Plugin) PipelineID ¶ added in v0.7.4

func (p *Plugin) PipelineID() string

PipelineID returns the GitHub Actions run ID.

func (*Plugin) Preflight ¶ added in v0.9.0

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

Preflight detects PR context when running inside GitHub Actions.

func (*Plugin) ProviderName ¶

func (p *Plugin) ProviderName() string

ProviderName returns the provider name.

func (*Plugin) SetAutoApprove ¶ added in v0.7.5

func (p *Plugin) SetAutoApprove(v bool)

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

func (*Plugin) SetPlanOnly ¶ added in v0.7.5

func (p *Plugin) SetPlanOnly(v bool)

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal Package githubci provides GitHub API client for PR integration	Package githubci provides GitHub API client for PR integration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL