bitrise

Documentation

Index

• Constants
• Variables
• func ApplyOutputAliases(onEnvs, basedOnEnvs []envmanModels.EnvironmentItemModel) ([]envmanModels.EnvironmentItemModel, error)
• func ApplySensitiveOutputs(onEnvs, basedOnEnvs []envmanModels.EnvironmentItemModel) ([]envmanModels.EnvironmentItemModel, error)
• func BuildStatusEnvs(isBuildFailed bool) []envmanModels.EnvironmentItemModel
• func CheckIsEnvmanInstalled(minEnvmanVersion string) error
• func CheckIsHomebrewInstalled() error
• func CheckIsPluginInstalled(name string, dependency PluginDependency) error
• func CheckIsStepmanInstalled(minStepmanVersion string) error
• func CleanupStepWorkDir() error
• func CollectEnvironmentsFromFile(pth string) ([]envmanModels.EnvironmentItemModel, error)
• func CollectEnvironmentsFromFileContent(bytes []byte) ([]envmanModels.EnvironmentItemModel, error)
• func ConfigModelFromFileContent(configBytes []byte, isJSON bool, validation ValidationType) (bitriseData models.BitriseDataModel, warnings []string, err error)
• func ConfigModelFromJSONBytes(configBytes []byte) (bitriseData models.BitriseDataModel, warnings []string, err error)
• func ConfigModelFromYAMLBytes(configBytes []byte) (bitriseData models.BitriseDataModel, warnings []string, err error)
• func ConfigModelFromYAMLBytesWithValidation(configBytes []byte, validation ValidationType) (bitriseData models.BitriseDataModel, warnings []string, err error)
• func EvaluateTemplateToBool(expStr string, isCI, isPR bool, buildResults models.BuildRunResultsModel, ...) (bool, error)
• func EvaluateTemplateToString(expStr string, isCI, isPR bool, buildResults models.BuildRunResultsModel, ...) (string, error)
• func FailedStepEnvs(failedStepRunResult models.StepRunResultsModel) []envmanModels.EnvironmentItemModel
• func InstallWithAptGetIfNeeded(aptGetDep stepmanModels.AptGetDepModel, isCIMode bool) error
• func InstallWithBrewIfNeeded(brewDep stepmanModels.BrewDepModel, isCIMode bool) error
• func InventoryModelFromYAMLBytes(inventoryBytes []byte) (inventory envmanModels.EnvsSerializeModel, err error)
• func PrintRunningWorkflow(title string)
• func PrintSummary(buildRunResults models.BuildRunResultsModel)
• func ReadBitriseConfig(pth string, validation ValidationType) (models.BitriseDataModel, []string, error)
• func ReadSpecStep(pth string) (stepmanModels.StepModel, error)
• func RunSetup(logger log.Logger, appVersion string, setupMode SetupMode, doCleanSetup bool) error
• func RunSetupIfNeeded(logger log.Logger) error
• type PluginDependency
• type SetupMode
• type TemplateDataModel
• type ValidationType

Constants

const FailedStepErrorMessageEnvVarSizeLimitInBytes = 1 * 1024

Variables

var PluginDependencyMap = map[string]PluginDependency{
	"init": {
		Source:     "https://github.com/bitrise-io/bitrise-plugins-init.git",
		MinVersion: "1.10.0",
	},
	"step": {
		Source:     "https://github.com/bitrise-io/bitrise-plugins-step.git",
		MinVersion: "0.10.4",
	},
	"workflow-editor": {
		Source:     "https://github.com/bitrise-io/bitrise-workflow-editor.git",
		MinVersion: "1.3.305",
	},
}

Functions

func ApplyOutputAliases

func ApplyOutputAliases(onEnvs, basedOnEnvs []envmanModels.EnvironmentItemModel) ([]envmanModels.EnvironmentItemModel, error)

func ApplySensitiveOutputs

func ApplySensitiveOutputs(onEnvs, basedOnEnvs []envmanModels.EnvironmentItemModel) ([]envmanModels.EnvironmentItemModel, error)

func BuildStatusEnvs

func BuildStatusEnvs(isBuildFailed bool) []envmanModels.EnvironmentItemModel

func CheckIsEnvmanInstalled

func CheckIsEnvmanInstalled(minEnvmanVersion string) error

CheckIsEnvmanInstalled ...

func CheckIsHomebrewInstalled

func CheckIsHomebrewInstalled() error

CheckIsHomebrewInstalled ...

func CheckIsPluginInstalled

func CheckIsPluginInstalled(name string, dependency PluginDependency) error

CheckIsPluginInstalled ...

func CheckIsStepmanInstalled

func CheckIsStepmanInstalled(minStepmanVersion string) error

CheckIsStepmanInstalled ...

func CleanupStepWorkDir

func CleanupStepWorkDir() error

func CollectEnvironmentsFromFile

func CollectEnvironmentsFromFile(pth string) ([]envmanModels.EnvironmentItemModel, error)

func CollectEnvironmentsFromFileContent

func CollectEnvironmentsFromFileContent(bytes []byte) ([]envmanModels.EnvironmentItemModel, error)

func ConfigModelFromFileContent

func ConfigModelFromFileContent(configBytes []byte, isJSON bool, validation ValidationType) (bitriseData models.BitriseDataModel, warnings []string, err error)

func ConfigModelFromJSONBytes

func ConfigModelFromJSONBytes(configBytes []byte) (bitriseData models.BitriseDataModel, warnings []string, err error)

func ConfigModelFromYAMLBytes

func ConfigModelFromYAMLBytes(configBytes []byte) (bitriseData models.BitriseDataModel, warnings []string, err error)

func ConfigModelFromYAMLBytesWithValidation

func ConfigModelFromYAMLBytesWithValidation(configBytes []byte, validation ValidationType) (bitriseData models.BitriseDataModel, warnings []string, err error)

func EvaluateTemplateToBool

func EvaluateTemplateToBool(expStr string, isCI, isPR bool, buildResults models.BuildRunResultsModel, envList envmanModels.EnvsJSONListModel) (bool, error)

func EvaluateTemplateToString

func EvaluateTemplateToString(expStr string, isCI, isPR bool, buildResults models.BuildRunResultsModel, envList envmanModels.EnvsJSONListModel) (string, error)

func FailedStepEnvs

func FailedStepEnvs(failedStepRunResult models.StepRunResultsModel) []envmanModels.EnvironmentItemModel

func InstallWithAptGetIfNeeded

func InstallWithAptGetIfNeeded(aptGetDep stepmanModels.AptGetDepModel, isCIMode bool) error

InstallWithAptGetIfNeeded ...

func InstallWithBrewIfNeeded

func InstallWithBrewIfNeeded(brewDep stepmanModels.BrewDepModel, isCIMode bool) error

InstallWithBrewIfNeeded ...

func InventoryModelFromYAMLBytes

func InventoryModelFromYAMLBytes(inventoryBytes []byte) (inventory envmanModels.EnvsSerializeModel, err error)

func PrintRunningWorkflow

func PrintRunningWorkflow(title string)

PrintRunningWorkflow ...

func PrintSummary

func PrintSummary(buildRunResults models.BuildRunResultsModel)

PrintSummary ...

func ReadBitriseConfig

func ReadBitriseConfig(pth string, validation ValidationType) (models.BitriseDataModel, []string, error)

func ReadSpecStep

func ReadSpecStep(pth string) (stepmanModels.StepModel, error)

func RunSetup

func RunSetup(logger log.Logger, appVersion string, setupMode SetupMode, doCleanSetup bool) error

func RunSetupIfNeeded

func RunSetupIfNeeded(logger log.Logger) error

Types

type PluginDependency

type PluginDependency struct {
	Source     string
	MinVersion string
}

type SetupMode

type SetupMode string

const (
	SetupModeDefault SetupMode = "default"
	SetupModeMinimal SetupMode = "minimal"
)

type TemplateDataModel

type TemplateDataModel struct {
	BuildResults  models.BuildRunResultsModel
	IsBuildFailed bool
	IsBuildOK     bool
	IsCI          bool
	IsPR          bool
	PullRequestID string
}

type ValidationType

type ValidationType int

const (
	ValidationTypeFull ValidationType = iota
	ValidationTypeMinimal
)