ci

Documentation

Index

• type Pipeline
  • func Detect() Pipeline
  • func (p Pipeline) String() string
• type Platform
• type Result
  • func Run(ctx context.Context, cfg *config.Config) (*Result, error)

Types

type Pipeline

type Pipeline struct {
	Platform Platform
	ScanOnly bool
}

func Detect

func Detect() Pipeline

func (Pipeline) String

func (p Pipeline) String() string

type Platform

type Platform string

const (
	PlatformGitHubActions Platform = "github-actions"
	PlatformGitLabCI      Platform = "gitlab-ci"
	PlatformJenkins       Platform = "jenkins"
	PlatformCircleCI      Platform = "circleci"
	PlatformLocal         Platform = "local"
)

type Result

type Result struct {
	ScanResult  *types.ScanResult
	Passed      bool
	Message     string
	CommentSent bool
}

func Run

func Run(ctx context.Context, cfg *config.Config) (*Result, error)