commands

package
v2.57.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 22, 2024 License: Apache-2.0 Imports: 31 Imported by: 19

Documentation

Index

Constants

View Source
const BuildConfVersion = 1

Variables

This section is empty.

Functions

func CreateBuildConfig added in v2.47.10

func CreateBuildConfig(c *cli.Context, confType project.ProjectType) (err error)

func CreateBuildConfigWithOptions added in v2.47.10

func CreateBuildConfigWithOptions(global bool, confType project.ProjectType, options ...ConfigOption) (err error)

func Exec

func Exec(command Command) error

func Export

func Export(serverName string) error

func GetAllServerIds

func GetAllServerIds() []string

func GetConfig

func GetConfig(serverId string, excludeRefreshableTokens bool) (*config.ServerDetails, error)

func Import

func Import(configTokenString string) (err error)

func ShowConfig

func ShowConfig(serverName string) error

Types

type AuthenticationMethod added in v2.18.7

type AuthenticationMethod string
const (
	AccessToken AuthenticationMethod = "Access Token"
	BasicAuth   AuthenticationMethod = "Username and Password / Reference token"
	MTLS        AuthenticationMethod = "Mutual TLS"
	WebLogin    AuthenticationMethod = "Web Login"
)

type Command

type Command interface {
	// Runs the command
	Run() error
	// Returns the Server details. The usage report is sent to this server.
	ServerDetails() (*config.ServerDetails, error)
	// The command name for the usage report.
	CommandName() string
}

type ConfigAction added in v2.16.0

type ConfigAction string
const (
	AddOrEdit ConfigAction = "AddOrEdit"
	Delete    ConfigAction = "Delete"
	Use       ConfigAction = "Use"
	Clear     ConfigAction = "Clear"
)

type ConfigCommand

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

func NewConfigCommand

func NewConfigCommand(cmdType ConfigAction, serverId string) *ConfigCommand

func (*ConfigCommand) CommandName

func (cc *ConfigCommand) CommandName() string

func (*ConfigCommand) ExecAndReportUsage added in v2.56.8

func (cc *ConfigCommand) ExecAndReportUsage() (err error)

ExecAndReportUsage runs the ConfigCommand and then triggers a usage report if needed, Report usage only if OIDC integration was used Usage must be sent after command execution as we need the server details to be set.

func (*ConfigCommand) Run

func (cc *ConfigCommand) Run() (err error)

func (*ConfigCommand) ServerDetails

func (cc *ConfigCommand) ServerDetails() (*config.ServerDetails, error)

func (*ConfigCommand) SetDefaultDetails

func (cc *ConfigCommand) SetDefaultDetails(defaultDetails *config.ServerDetails) *ConfigCommand

func (*ConfigCommand) SetDetails

func (cc *ConfigCommand) SetDetails(details *config.ServerDetails) *ConfigCommand

func (*ConfigCommand) SetEncPassword

func (cc *ConfigCommand) SetEncPassword(encPassword bool) *ConfigCommand

func (*ConfigCommand) SetInteractive

func (cc *ConfigCommand) SetInteractive(interactive bool) *ConfigCommand

func (*ConfigCommand) SetMakeDefault added in v2.38.0

func (cc *ConfigCommand) SetMakeDefault(makeDefault bool) *ConfigCommand

func (*ConfigCommand) SetServerId

func (cc *ConfigCommand) SetServerId(serverId string) *ConfigCommand

func (*ConfigCommand) SetUseBasicAuthOnly

func (cc *ConfigCommand) SetUseBasicAuthOnly(useBasicAuthOnly bool) *ConfigCommand

func (*ConfigCommand) SetUseWebLogin added in v2.38.0

func (cc *ConfigCommand) SetUseWebLogin(useWebLogin bool) *ConfigCommand

type ConfigCommandConfiguration

type ConfigCommandConfiguration struct {
	ServerDetails *config.ServerDetails
	Interactive   bool
	EncPassword   bool
	BasicAuthOnly bool
}

type ConfigFile added in v2.47.10

type ConfigFile struct {
	Interactive bool               `yaml:"-"`
	Version     int                `yaml:"version,omitempty"`
	ConfigType  string             `yaml:"type,omitempty"`
	Resolver    project.Repository `yaml:"resolver,omitempty"`
	Deployer    project.Repository `yaml:"deployer,omitempty"`
	UsePlugin   bool               `yaml:"usePlugin,omitempty"`
	UseWrapper  bool               `yaml:"useWrapper,omitempty"`
}

func NewConfigFile added in v2.47.10

func NewConfigFile(confType project.ProjectType, c *cli.Context) *ConfigFile

func NewConfigFileWithOptions added in v2.47.10

func NewConfigFileWithOptions(confType project.ProjectType, options ...ConfigOption) *ConfigFile

func (*ConfigFile) VerifyConfigFile added in v2.47.10

func (configFile *ConfigFile) VerifyConfigFile(configFilePath string) error

Verify config file doesn't exist or prompt to override it

type ConfigOption added in v2.47.10

type ConfigOption func(c *ConfigFile)

func UsePlugin added in v2.47.10

func UsePlugin(usePlugin bool) ConfigOption

func UseWrapper added in v2.47.10

func UseWrapper(useWrapper bool) ConfigOption

func WithArtifactsDeploymentPattern added in v2.47.10

func WithArtifactsDeploymentPattern(artifactsPattern string) ConfigOption

func WithDeployerExcludePatterns added in v2.47.10

func WithDeployerExcludePatterns(excludePatterns string) ConfigOption

func WithDeployerIncludePatterns added in v2.47.10

func WithDeployerIncludePatterns(includePatterns string) ConfigOption

func WithDeployerReleaseRepo added in v2.47.10

func WithDeployerReleaseRepo(repoId string) ConfigOption

func WithDeployerRepo added in v2.47.10

func WithDeployerRepo(repoId string) ConfigOption

func WithDeployerServerId added in v2.47.10

func WithDeployerServerId(serverId string) ConfigOption

func WithDeployerSnapshotRepo added in v2.47.10

func WithDeployerSnapshotRepo(repoId string) ConfigOption

func WithIvyDeploymentPattern added in v2.47.10

func WithIvyDeploymentPattern(ivyPattern string) ConfigOption

func WithIvyDescDeployment added in v2.47.10

func WithIvyDescDeployment(ivyDesc bool) ConfigOption

func WithMavenDescDeployment added in v2.47.10

func WithMavenDescDeployment(mavenDesc bool) ConfigOption

func WithResolverNugetV2 added in v2.47.10

func WithResolverNugetV2(nugetV2 bool) ConfigOption

func WithResolverReleaseRepo added in v2.47.10

func WithResolverReleaseRepo(repoId string) ConfigOption

func WithResolverRepo added in v2.47.10

func WithResolverRepo(repoId string) ConfigOption

func WithResolverServerId added in v2.47.10

func WithResolverServerId(serverId string) ConfigOption

func WithResolverSnapshotRepo added in v2.47.10

func WithResolverSnapshotRepo(repoId string) ConfigOption

type CurlCommand

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

func NewCurlCommand

func NewCurlCommand() *CurlCommand

func (*CurlCommand) GetCmd

func (curlCmd *CurlCommand) GetCmd() *exec.Cmd

func (*CurlCommand) GetEnv

func (curlCmd *CurlCommand) GetEnv() map[string]string

func (*CurlCommand) GetErrWriter

func (curlCmd *CurlCommand) GetErrWriter() io.WriteCloser

func (*CurlCommand) GetServerDetails

func (curlCmd *CurlCommand) GetServerDetails() (*config.ServerDetails, error)

Returns server details

func (*CurlCommand) GetStdWriter

func (curlCmd *CurlCommand) GetStdWriter() io.WriteCloser

func (*CurlCommand) Run

func (curlCmd *CurlCommand) Run() error

func (*CurlCommand) ServerDetails

func (curlCmd *CurlCommand) ServerDetails() (*config.ServerDetails, error)

func (*CurlCommand) SetArguments

func (curlCmd *CurlCommand) SetArguments(arguments []string) *CurlCommand

func (*CurlCommand) SetExecutablePath

func (curlCmd *CurlCommand) SetExecutablePath(executablePath string) *CurlCommand

func (*CurlCommand) SetServerDetails

func (curlCmd *CurlCommand) SetServerDetails(serverDetails *config.ServerDetails) *CurlCommand

func (*CurlCommand) SetUrl

func (curlCmd *CurlCommand) SetUrl(url string) *CurlCommand

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL