maven

Documentation

Index

• func Evaluate(pomFile, expression string, command mavenExecRunner) (string, error)
• func Execute(options *ExecuteOptions, command mavenExecRunner) (string, error)
• func GetSettingsFile(settingsFileType SettingsFileType, src string, fileUtils piperutils.FileUtils, ...) error
• func GetTestModulesExcludes() []string
• type ExecuteOptions
• type SettingsFileType

Functions

func Evaluate

func Evaluate(pomFile, expression string, command mavenExecRunner) (string, error)

Evaluate constructs ExecuteOptions for using the maven-help-plugin's 'evaluate' goal to evaluate a given expression from a pom file. This allows to retrieve the value of - for example - 'project.version' from a pom file exactly as Maven itself evaluates it.

func Execute

func Execute(options *ExecuteOptions, command mavenExecRunner) (string, error)

Execute constructs a mvn command line from the given options, and uses the provided mavenExecRunner to execute it.

func GetSettingsFile

func GetSettingsFile(settingsFileType SettingsFileType, src string, fileUtils piperutils.FileUtils, httpClient piperhttp.Downloader) error

GetSettingsFile ...

func GetTestModulesExcludes

func GetTestModulesExcludes() []string

Types

type ExecuteOptions

type ExecuteOptions struct {
	PomPath                     string   `json:"pomPath,omitempty"`
	ProjectSettingsFile         string   `json:"projectSettingsFile,omitempty"`
	GlobalSettingsFile          string   `json:"globalSettingsFile,omitempty"`
	M2Path                      string   `json:"m2Path,omitempty"`
	Goals                       []string `json:"goals,omitempty"`
	Defines                     []string `json:"defines,omitempty"`
	Flags                       []string `json:"flags,omitempty"`
	LogSuccessfulMavenTransfers bool     `json:"logSuccessfulMavenTransfers,omitempty"`
	ReturnStdout                bool     `json:"returnStdout,omitempty"`
}

ExecuteOptions are used by Execute() to construct the Maven command line.

type SettingsFileType

type SettingsFileType int

SettingsFileType ...

const (
	// GlobalSettingsFile ...
	GlobalSettingsFile SettingsFileType = iota
	// ProjectSettingsFile ...
	ProjectSettingsFile
)