osc

Documentation

Index

• Constants
• func CreateOSCConfigFile(apiURL, username, password string) error
• func OSC(workDir string, args ...string) error
• func Output(workDir string, args ...string) (string, error)
• func PreCheck() error
• func Status(workDir string, args ...string) (*command.Status, error)
• func Version() (*semver.Version, error)
• func WaitResults(project, packageName string) error

Constants

const (
	// OSCExecutable is the name of the OpenBuildService CLI executable
	OSCExecutable = "osc"
)

Functions

func CreateOSCConfigFile

func CreateOSCConfigFile(apiURL, username, password string) error

CreateOSCConfigFile creates the osc config file (~/.oscrc) that contains API URL and credentials needed to authenticate with the API

func OSC

func OSC(workDir string, args ...string) error

OSC can be used to run a 'osc' command

func Output

func Output(workDir string, args ...string) (string, error)

Output can be used to run a 'osc' command while capturing its output

func PreCheck

func PreCheck() error

PreCheck checks if all requirements are fulfilled to run this package and all sub-packages

func Status

func Status(workDir string, args ...string) (*command.Status, error)

Status can be used to run a 'osc' command while capturing its status

func Version

func Version() (*semver.Version, error)

Version returns the semver version of the osc executable.

func WaitResults

func WaitResults(project, packageName string) error

WaitResults waits for the build results. If can fail on error if an osc version >= 1.8.0 is being used.