cli

Documentation

Index

• Constants
• func CopyFile(src, dst string, remove bool) error
• func CreateBitriseConfigFromCLIParams(bitriseConfigBase64Data, bitriseConfigPath string) (models.BitriseDataModel, []string, error)
• func CreateInventoryFromCLIParams(inventoryBase64Data, inventoryPath string) ([]envmanModels.EnvironmentItemModel, error)
• func GetBitriseConfigFilePath(bitriseConfigPath string) (string, error)
• func GetBitriseConfigFromBase64Data(configBase64Str string) (models.BitriseDataModel, []string, error)
• func GetInventoryFilePath(inventoryPath string) (string, error)
• func GetInventoryFromBase64Data(inventoryBase64Str string) ([]envmanModels.EnvironmentItemModel, error)
• func PrintBitriseHeaderASCIIArt(appVersion string)
• func Run()
• type RunAndTriggerParamsModel
• type ValidateResponseModel
  • func NewValidationError(err string, warnings ...string) ValidateResponseModel
  • func NewValidationResponse(validation ValidationModel, warnings ...string) ValidateResponseModel
  • func (v ValidateResponseModel) JSON() string
  • func (v ValidateResponseModel) String() string
• type ValidationItemModel
• type ValidationModel
  • func (v ValidationModel) IsValid() bool
  • func (v ValidationModel) String() string
• type VersionOutputModel
• type WorkflowListOutputModel
  • func NewErrorOutput(err string, warnings ...string) WorkflowListOutputModel
  • func NewOutput(data map[string]map[string]string, warnings ...string) WorkflowListOutputModel
  • func (output WorkflowListOutputModel) JSON() string
  • func (output WorkflowListOutputModel) String() string

Constants

const (
	JSONParamsKey       = "json-params"
	JSONParamsBase64Key = "json-params-base64"

	WorkflowKey = "workflow"

	PatternKey        = "pattern"
	PushBranchKey     = "push-branch"
	PRSourceBranchKey = "pr-source-branch"
	PRTargetBranchKey = "pr-target-branch"

	IncludeWorkflowMetaKey = "include-workflow-meta"
	ConfigKey              = "config"
	InventoryKey           = "inventory"
	OuputFormatKey         = "format"
)

Flags ...

const (
	// CollectionPathEnvKey ...
	CollectionPathEnvKey = "STEPMAN_COLLECTION"
	// CIKey ...
	CIKey = "ci"
	// SilentKey ...
	SilentKey = "silent"
	// PRKey ...
	PRKey = "pr"
	// DebugModeKey ...
	DebugModeKey = "debug"

	// LogLevelKey ...
	LogLevelKey = "loglevel"

	// VersionKey ...
	VersionKey = "version"

	// PathKey ...
	PathKey = "path"

	// CollectionKey ...
	CollectionKey = "collection"

	// InventoryBase64Key ...
	InventoryBase64Key = "inventory-base64"

	// ConfigBase64Key ...
	ConfigBase64Key = "config-base64"

	// HelpKey ...
	HelpKey = "help"

	// MinimalModeKey ...
	MinimalModeKey = "minimal"
	// FullModeKey ...
	FullModeKey = "full"

	// OuputPathKey ...
	OuputPathKey = "outpath"
	// PrettyFormatKey ...
	PrettyFormatKey = "pretty"

	// IDKey ...
	IDKey = "id"

	// ShortKey ...
	ShortKey = "short"

	// StepYMLKey ...
	StepYMLKey = "step-yml"

	// TagKey ...
	TagKey = "tag"
	// GitKey ...
	GitKey = "git"
	// StepIDKey ...
	StepIDKey = "stepid"
)

const (
	// DefaultBitriseConfigFileName ...
	DefaultBitriseConfigFileName = "bitrise.yml"
	// DefaultSecretsFileName ...
	DefaultSecretsFileName = ".bitrise.secrets.yml"
)

Functions

func CopyFile

func CopyFile(src, dst string, remove bool) error

CopyFile ...

func CreateBitriseConfigFromCLIParams

func CreateBitriseConfigFromCLIParams(bitriseConfigBase64Data, bitriseConfigPath string) (models.BitriseDataModel, []string, error)

CreateBitriseConfigFromCLIParams ...

func CreateInventoryFromCLIParams

func CreateInventoryFromCLIParams(inventoryBase64Data, inventoryPath string) ([]envmanModels.EnvironmentItemModel, error)

CreateInventoryFromCLIParams ...

func GetBitriseConfigFilePath

func GetBitriseConfigFilePath(bitriseConfigPath string) (string, error)

GetBitriseConfigFilePath ...

func GetBitriseConfigFromBase64Data

func GetBitriseConfigFromBase64Data(configBase64Str string) (models.BitriseDataModel, []string, error)

GetBitriseConfigFromBase64Data ...

func GetInventoryFilePath

func GetInventoryFilePath(inventoryPath string) (string, error)

GetInventoryFilePath ...

func GetInventoryFromBase64Data

func GetInventoryFromBase64Data(inventoryBase64Str string) ([]envmanModels.EnvironmentItemModel, error)

GetInventoryFromBase64Data ...

func PrintBitriseHeaderASCIIArt

func PrintBitriseHeaderASCIIArt(appVersion string)

PrintBitriseHeaderASCIIArt ...

func Run

func Run()

Run ...

Types

type RunAndTriggerParamsModel

type RunAndTriggerParamsModel struct {
	// Run Params
	WorkflowToRunID string `json:"workflow"`

	// Trigger Params
	TriggerPattern string `json:"pattern"`

	PushBranch     string `json:"push-branch"`
	PRSourceBranch string `json:"pr-source-branch"`
	PRTargetBranch string `json:"pr-target-branch"`
	Tag            string `json:"tag"`

	// Trigger Check Params
	Format string `json:"format"`

	// Bitrise Config Params
	BitriseConfigPath       string `json:"config"`
	BitriseConfigBase64Data string `json:"config-base64"`

	InventoryPath       string `json:"inventory"`
	InventoryBase64Data string `json:"inventory-base64"`
}

RunAndTriggerParamsModel ...

type ValidateResponseModel

type ValidateResponseModel struct {
	Data     *ValidationModel `json:"data,omitempty" yaml:"data,omitempty"`
	Error    string           `json:"error,omitempty" yaml:"error,omitempty"`
	Warnings []string         `json:"warnings,omitempty" yaml:"warnings,omitempty"`
}

ValidateResponseModel ...

func NewValidationError

func NewValidationError(err string, warnings ...string) ValidateResponseModel

NewValidationError ...

func NewValidationResponse

func NewValidationResponse(validation ValidationModel, warnings ...string) ValidateResponseModel

NewValidationResponse ...

func (ValidateResponseModel) JSON

func (v ValidateResponseModel) JSON() string

JSON ...

func (ValidateResponseModel) String

func (v ValidateResponseModel) String() string

type ValidationItemModel

type ValidationItemModel struct {
	IsValid  bool     `json:"is_valid" yaml:"is_valid"`
	Error    string   `json:"error,omitempty" yaml:"error,omitempty"`
	Warnings []string `json:"warnings,omitempty" yaml:"warnings,omitempty"`
}

ValidationItemModel ...

type ValidationModel

type ValidationModel struct {
	Config  *ValidationItemModel `json:"config,omitempty" yaml:"config,omitempty"`
	Secrets *ValidationItemModel `json:"secrets,omitempty" yaml:"secrets,omitempty"`
}

ValidationModel ...

func (ValidationModel) IsValid

func (v ValidationModel) IsValid() bool

IsValid ...

func (ValidationModel) String

func (v ValidationModel) String() string

String ...

type VersionOutputModel

type VersionOutputModel struct {
	Version       string `json:"version"`
	FormatVersion string `json:"format_version"`
	OS            string `json:"os"`
	GO            string `json:"go"`
	BuildNumber   string `json:"build_number"`
	Commit        string `json:"commit"`
}

VersionOutputModel ...

type WorkflowListOutputModel

type WorkflowListOutputModel struct {
	Data     map[string]map[string]string `json:"data,omitempty" yml:"data,omitempty"`
	Warnings []string                     `json:"warnings,omitempty" yml:"warnings,omitempty"`
	Error    string                       `json:"error,omitempty" yml:"error,omitempty"`
}

WorkflowListOutputModel ...

func NewErrorOutput

func NewErrorOutput(err string, warnings ...string) WorkflowListOutputModel

NewErrorOutput ...

func NewOutput

func NewOutput(data map[string]map[string]string, warnings ...string) WorkflowListOutputModel

NewOutput ...

func (WorkflowListOutputModel) JSON

func (output WorkflowListOutputModel) JSON() string

JSON ...

func (WorkflowListOutputModel) String

func (output WorkflowListOutputModel) String() string

String ...