cicontext

package

v1.3.0 Latest Latest Go to latest Published: Mar 2, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

This section is empty.

type BuildType string

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

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

func Detect() (CIContext, error)

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

type GithubActionsDetector struct{}

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() bool