cli

Documentation

Index

• Constants
• 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 ValidationItemModel
• type ValidationModel
• type VersionOutputModel

Constants

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

	// WorkflowKey ...
	WorkflowKey = "workflow"

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

	// ConfigKey ...
	ConfigKey = "config"
	// InventoryKey ...
	InventoryKey = "inventory"

	// OuputFormatKey ...
	OuputFormatKey = "format"
)

const (
	// CollectionPathEnvKey ...
	CollectionPathEnvKey = "STEPMAN_COLLECTION"
	// CIKey ...
	CIKey = "ci"
	// 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 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"`

	// 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 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 ...

type VersionOutputModel

type VersionOutputModel struct {
	Version     string `json:"version"`
	BuildNumber string `json:"build_number"`
	Commit      string `json:"commit"`
}

VersionOutputModel ...