metadata

Documentation

Index

• Constants
• Variables
• func GetBaseRef() (r string)
• func GetBuildInfo(buildSystem string) (run string, buildID string)
• func GetBuildSystem() string
• func GetCommitID(scanPath string) (commitId string)
• func GetFullBranchName(branchName string) string
• func GetGitUser(scanPath string) (gitUser string)
• func GetImageDetails(imageName string) (prefix, repo, tag string)
• func GetRepositoryDetails(scanPath string, cmd string) (repoName, branch string, err error)
• func GetRepositoryUrl(prefix, repo string) string
• func GetScmID(scanPath string) string

Constants

const (
	Bitbucket = "bitbucket"
	Jenkins   = "jenkins"
	Gitlab    = "gitlab"
	Codebuild = "codebuild"
	Azure     = "azure"
	Github    = "github"
)

Variables

var (
	// SHARegexp is used to split an image digest value to a registry prefix,
	// repository name, and the SHA256 hash.
	SHARegexp = regexp.MustCompile(`^(?:([^/]+)/)([^@]+)(@sha256:[0-9a-f]+)$`)

	// SplitImageNameRegexp is used to split a fully qualified image name to a
	// registry prefix, repository name and image tag.
	SplitImageNameRegexp = regexp.MustCompile(`^(?:([^/]+)/)?([^:]+)(?::(.*))?$`)
	// PortRegexp is used to check whether a string ends with a port suffix
	// (e.g. :8080)
	PortRegexp = regexp.MustCompile(`:\d+$`)
)

Functions

func GetBaseRef

func GetBaseRef() (r string)

func GetBuildInfo

func GetBuildInfo(buildSystem string) (run string, buildID string)

GetBuildInfo the vendor build run number and id

func GetBuildSystem

func GetBuildSystem() string

func GetCommitID

func GetCommitID(scanPath string) (commitId string)

GetCommitID gets the current CommitID of the repository

func GetFullBranchName

func GetFullBranchName(branchName string) string

func GetGitUser

func GetGitUser(scanPath string) (gitUser string)

GetGitUser attempts to get the user who performed the most recent commit

func GetImageDetails

func GetImageDetails(imageName string) (prefix, repo, tag string)

GetImageDetails gets the full name of an image (e.g. "repo/test:master", or even "docker.io/repo/test:master") and splits it into the registry prefix, repository name and the image tag (e.g. "docker.io", "repo/test" and "master" in the previous example).

func GetRepositoryDetails

func GetRepositoryDetails(scanPath string, cmd string) (repoName, branch string, err error)

GetRepositoryDetails gets the repository name and branch multiple env vars will be checked first before falling back to the folder name

func GetRepositoryUrl

func GetRepositoryUrl(prefix, repo string) string

func GetScmID

func GetScmID(scanPath string) string

GetScmID extracts the git path from the config file