build

Documentation

Index

• Constants
• type Build
  • func NewBuild(buildName, buildNumber, projectKey, tempDirPath string, logger utils.Log) *Build
  • func (b *Build) AddGoModule(srcPath string) (*GoModule, error)
  • func (b *Build) AddGradleModule(srcPath string) (*GradleModule, error)
  • func (b *Build) AddMavenModule(srcPath string) (*MavenModule, error)
  • func (b *Build) AddNpmModule(srcPath string) (*NpmModule, error)
  • func (b *Build) Clean() error
  • func (b *Build) CollectEnv() error
  • func (b *Build) SaveBuildInfo(buildInfo *entities.BuildInfo) (err error)
  • func (b *Build) SavePartialBuildInfo(partial *entities.Partial) (err error)
  • func (b *Build) SetAgentName(agentName string)
  • func (b *Build) SetAgentVersion(agentVersion string)
  • func (b *Build) SetBuildAgentVersion(buildAgentVersion string)
  • func (b *Build) SetBuildUrl(buildUrl string)
  • func (b *Build) SetPrincipal(principal string)
  • func (b *Build) ToBuildInfo() (*entities.BuildInfo, error)
• type BuildInfoService
  • func NewBuildInfoService() *BuildInfoService
  • func (bis *BuildInfoService) GetOrCreateBuild(buildName, buildNumber string) (*Build, error)
  • func (bis *BuildInfoService) GetOrCreateBuildWithProject(buildName, buildNumber, projectKey string) (*Build, error)
  • func (bis *BuildInfoService) SetLogger(logger utils.Log)
  • func (bis *BuildInfoService) SetTempDirPath(tempDirPath string)
• type GoModule
  • func (gm *GoModule) AddArtifacts(artifacts ...entities.Artifact) error
  • func (gm *GoModule) CalcDependencies() error
  • func (gm *GoModule) SetName(name string)
• type GradleModule
  • func (gm *GradleModule) CalcDependencies() (err error)
  • func (gm *GradleModule) SetExtractorDetails(localExtractorPath, extractorPropsDir string, tasks []string, ...) *GradleModule
• type MavenModule
  • func (mm *MavenModule) CalcDependencies() error
  • func (mm *MavenModule) SetExtractorDetails(localdExtractorPath, extractorPropsdir string, goals []string, ...) *MavenModule
  • func (mm *MavenModule) SetMavenGoals(goals ...string)
  • func (mm *MavenModule) SetMavenOpts(mavenOpts ...string)
• type NpmModule
  • func (nm *NpmModule) AddArtifacts(artifacts ...entities.Artifact) error
  • func (nm *NpmModule) CalcDependencies() error
  • func (nm *NpmModule) SetName(name string)
  • func (nm *NpmModule) SetNpmArgs(npmArgs []string)
  • func (nm *NpmModule) SetThreads(threads int)
  • func (nm *NpmModule) SetTraverseDependenciesFunc(traverseDependenciesFunc func(dependency *entities.Dependency) (bool, error))
  • func (nm *NpmModule) SetTypeRestriction(typeRestriction utils.TypeRestriction)

Constants

const (
	GradleExtractorFileName = "build-info-extractor-gradle-%s-uber.jar"

	GradleExtractorRemotePath        = "org/jfrog/buildinfo/build-info-extractor-gradle/%s"
	GradleExtractorDependencyVersion = "4.26.0"
)

const (
	MavenHome = "M2_HOME"

	MavenExtractorFileName = "build-info-extractor-maven3-%s-uber.jar"

	PropertiesTempfolderName = "properties"

	GeneratedBuildInfoTempPrefix    = "generatedBuildInfo"
	MavenExtractorDependencyVersion = "2.33.0"

	ClassworldsConf = `` /* 171-byte string literal not displayed */

)

const BuildInfoDetails = "details"

const BuildsTempPath = "jfrog/builds/"

const GradleInitScript = `` /* 1384-byte string literal not displayed */

Types

type Build

type Build struct {
	// contains filtered or unexported fields
}

func NewBuild

func NewBuild(buildName, buildNumber, projectKey, tempDirPath string, logger utils.Log) *Build

func (*Build) AddGoModule

func (b *Build) AddGoModule(srcPath string) (*GoModule, error)

AddGoModule adds a Go module to this Build. Pass srcPath as an empty string if the root of the Go project is the working directory.

func (*Build) AddGradleModule

func (b *Build) AddGradleModule(srcPath string) (*GradleModule, error)

AddGradleModule adds a Gradle module to this Build. Pass srcPath as an empty string if the root of the Gradle project is the working directory.

func (*Build) AddMavenModule

func (b *Build) AddMavenModule(srcPath string) (*MavenModule, error)

AddMavenModule adds a Maven module to this Build. Pass srcPath as an empty string if the root of the Maven project is the working directory.

func (*Build) AddNpmModule

func (b *Build) AddNpmModule(srcPath string) (*NpmModule, error)

func (*Build) Clean

func (b *Build) Clean() error

func (*Build) CollectEnv

func (b *Build) CollectEnv() error

func (*Build) SaveBuildInfo

func (b *Build) SaveBuildInfo(buildInfo *entities.BuildInfo) (err error)

func (*Build) SavePartialBuildInfo

func (b *Build) SavePartialBuildInfo(partial *entities.Partial) (err error)

SavePartialBuildInfo saves the given partial in the builds directory. The partial's Timestamp field is set inside this function.

func (*Build) SetAgentName

func (b *Build) SetAgentName(agentName string)

This field is not saved in local cache. It is used only when creating a build-info using the ToBuildInfo() function.

func (*Build) SetAgentVersion

func (b *Build) SetAgentVersion(agentVersion string)

This field is not saved in local cache. It is used only when creating a build-info using the ToBuildInfo() function.

func (*Build) SetBuildAgentVersion

func (b *Build) SetBuildAgentVersion(buildAgentVersion string)

This field is not saved in local cache. It is used only when creating a build-info using the ToBuildInfo() function.

func (*Build) SetBuildUrl

func (b *Build) SetBuildUrl(buildUrl string)

This field is not saved in local cache. It is used only when creating a build-info using the ToBuildInfo() function.

func (*Build) SetPrincipal

func (b *Build) SetPrincipal(principal string)

This field is not saved in local cache. It is used only when creating a build-info using the ToBuildInfo() function.

func (*Build) ToBuildInfo

func (b *Build) ToBuildInfo() (*entities.BuildInfo, error)

type BuildInfoService

type BuildInfoService struct {
	// contains filtered or unexported fields
}

func NewBuildInfoService

func NewBuildInfoService() *BuildInfoService

func (*BuildInfoService) GetOrCreateBuild

func (bis *BuildInfoService) GetOrCreateBuild(buildName, buildNumber string) (*Build, error)

GetOrCreateBuild gets a build from cache, or creates a new one if it doesn't exist. It's important to invoke this function at the very beginning of the build, so that the start time property in the build-info will be accurate.

func (*BuildInfoService) GetOrCreateBuildWithProject

func (bis *BuildInfoService) GetOrCreateBuildWithProject(buildName, buildNumber, projectKey string) (*Build, error)

GetOrCreateBuildWithProject gets a build from cache, or creates a new one if it doesn't exist. It's important to invoke this function at the very beginning of the build, so that the start time property in the build-info will be accurate.

func (*BuildInfoService) SetLogger

func (bis *BuildInfoService) SetLogger(logger utils.Log)

func (*BuildInfoService) SetTempDirPath

func (bis *BuildInfoService) SetTempDirPath(tempDirPath string)

type GoModule

type GoModule struct {
	// contains filtered or unexported fields
}

func (*GoModule) AddArtifacts

func (gm *GoModule) AddArtifacts(artifacts ...entities.Artifact) error

func (*GoModule) CalcDependencies

func (gm *GoModule) CalcDependencies() error

func (*GoModule) SetName

func (gm *GoModule) SetName(name string)

type GradleModule

type GradleModule struct {
	// contains filtered or unexported fields
}

func (*GradleModule) CalcDependencies

func (gm *GradleModule) CalcDependencies() (err error)

Generates Gradle build-info.

func (*GradleModule) SetExtractorDetails

func (gm *GradleModule) SetExtractorDetails(localExtractorPath, extractorPropsDir string, tasks []string, useWrapper, usePlugin bool, downloadExtractorFunc func(downloadTo, downloadFrom string) error, props map[string]string) *GradleModule

type MavenModule

type MavenModule struct {
	// contains filtered or unexported fields
}

func (*MavenModule) CalcDependencies

func (mm *MavenModule) CalcDependencies() error

Generates Maven build-info.

func (*MavenModule) SetExtractorDetails

func (mm *MavenModule) SetExtractorDetails(localdExtractorPath, extractorPropsdir string, goals []string, downloadExtractorFunc func(downloadTo, downloadFrom string) error, configProps map[string]string) *MavenModule

func (*MavenModule) SetMavenGoals

func (mm *MavenModule) SetMavenGoals(goals ...string)

func (*MavenModule) SetMavenOpts

func (mm *MavenModule) SetMavenOpts(mavenOpts ...string)

type NpmModule

type NpmModule struct {
	// contains filtered or unexported fields
}

func (*NpmModule) AddArtifacts

func (nm *NpmModule) AddArtifacts(artifacts ...entities.Artifact) error

func (*NpmModule) CalcDependencies

func (nm *NpmModule) CalcDependencies() error

func (*NpmModule) SetName

func (nm *NpmModule) SetName(name string)

func (*NpmModule) SetNpmArgs

func (nm *NpmModule) SetNpmArgs(npmArgs []string)

func (*NpmModule) SetThreads

func (nm *NpmModule) SetThreads(threads int)

func (*NpmModule) SetTraverseDependenciesFunc

func (nm *NpmModule) SetTraverseDependenciesFunc(traverseDependenciesFunc func(dependency *entities.Dependency) (bool, error))

SetTraverseDependenciesFunc gets a function to execute on all dependencies after their collection in CalcDependencies(), before they're saved. This function needs to return a boolean value indicating whether to save this dependency in the build-info or not. This function might run asynchronously with different dependencies (if the threads amount setting is bigger than 1). If more than one error are returned from this function in different threads, only the first of them will be returned from CalcDependencies().

func (*NpmModule) SetTypeRestriction

func (nm *NpmModule) SetTypeRestriction(typeRestriction utils.TypeRestriction)