github

package
v0.7.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

Index

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) CommitSHA added in v0.7.4

func (p *Plugin) CommitSHA() string

CommitSHA returns the GitHub Actions commit SHA.

func (*Plugin) ConfigKey

func (p *Plugin) ConfigKey() string

ConfigKey returns the config key for the GitHub plugin.

func (*Plugin) Description

func (p *Plugin) Description() string

func (*Plugin) DetectEnv

func (p *Plugin) DetectEnv() bool

DetectEnv returns true if running in GitHub Actions.

func (*Plugin) InitGroup

func (p *Plugin) InitGroup() *plugin.InitGroupSpec

InitGroup returns the init wizard group spec for GitHub Actions.

func (*Plugin) Initialize

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

Initialize detects PR context at startup.

func (*Plugin) IsConfigured

func (p *Plugin) IsConfigured() bool

IsConfigured returns whether the plugin has been configured.

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) NewCommentService

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

NewCommentService creates a new PR comment service.

func (*Plugin) NewConfig

func (p *Plugin) NewConfig() any

NewConfig returns a new default GitHub config.

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) PipelineID added in v0.7.4

func (p *Plugin) PipelineID() string

PipelineID returns the GitHub Actions run ID.

func (*Plugin) ProviderName

func (p *Plugin) ProviderName() string

ProviderName returns the provider name.

func (*Plugin) SetConfig

func (p *Plugin) SetConfig(cfg any) error

SetConfig sets the GitHub plugin configuration.

Directories

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

Jump to

Keyboard shortcuts

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