cicontext

Documentation

Index

• Variables
• type BuildType
• type CIContext
  • func Detect() (CIContext, error)
• type CIProvider
• type GithubActionsDetector
  • func (g *GithubActionsDetector) InferContext() (CIContext, error)
  • func (*GithubActionsDetector) IsProvider() bool

Variables

var (
	ErrWrongCIProvider = errors.New("wrong ci provider")
)

Types

type BuildType

type BuildType string

const (
	PullRequest BuildType = "pull_request"
	Push        BuildType = "push"
)

type CIContext

type CIContext struct {
	Repo       string
	Owner      string
	CommitSHA  string
	BranchName string
}

func Detect

func Detect() (CIContext, error)

type CIProvider

type CIProvider interface {
	IsProvider() bool
	InferContext() (CIContext, error)
}

type GithubActionsDetector

type GithubActionsDetector struct{}

func (*GithubActionsDetector) InferContext

func (g *GithubActionsDetector) InferContext() (CIContext, error)

InferContext infers the CIContext using environment variables It assumes the correct provider was identified via IsProvider For more reference of what each environment variable represents, Check Github Action's documentation at https://docs.github.com/en/actions/learn-github-actions/environment-variables

func (*GithubActionsDetector) IsProvider

func (*GithubActionsDetector) IsProvider() bool