github

Documentation

Index

• func Available() bool
• func Enable()
• func FromEnv() ci.Provider
• type Pipeline
  • func (p Pipeline) BuildID() string
  • func (p *Pipeline) SetBuildID(id string)

Functions

func Available

func Available() bool

Available returns true if the code is executed in a github CI environment.

func Enable

func Enable()

Enable enables this provider integration.

func FromEnv

func FromEnv() ci.Provider

FromEnv creates a new Pipeline from the environment.

Types

type Pipeline

type Pipeline struct {
	GithubWorkflow string
	GithubRunID    string
	// contains filtered or unexported fields
}

Pipeline represents the current pipeline information.

func (Pipeline) BuildID

func (p Pipeline) BuildID() string

BuildID returns a build ID.

func (*Pipeline) SetBuildID

func (p *Pipeline) SetBuildID(id string)

SetBuildID overrides the return value for BuildID().