step

Documentation

Index

• type CodesignManagerOpts
• type Config
• type ExportOpts
• type FileManager
  • func NewFileManager() FileManager
• type Input
• type RunOut
• type XcodebuildBuilder
  • func NewXcodebuildBuilder(logger v2log.Logger, xcodeproject xcodeproject.XcodeProject, ...) XcodebuildBuilder
  • func (b XcodebuildBuilder) ExportOutputs(opts ExportOpts) error
  • func (b XcodebuildBuilder) InstallDependencies(useXCPretty bool) error
  • func (b XcodebuildBuilder) ProcessConfig() (Config, error)
  • func (b XcodebuildBuilder) Run(cfg Config) (RunOut, error)

Types

type CodesignManagerOpts

type CodesignManagerOpts struct {
	ProjectPath               string
	Scheme                    string
	Configuration             string
	CodeSigningAuthSource     string
	RegisterTestDevices       bool
	TestDeviceListPath        string
	MinDaysProfileValid       int
	TeamID                    string
	CertificateURLList        string
	CertificatePassphraseList stepconf.Secret
	KeychainPath              string
	KeychainPassword          stepconf.Secret
	BuildURL                  string
	BuildAPIToken             stepconf.Secret
	VerboseLog                bool
	APIKeyPath                stepconf.Secret
	APIKeyID                  string
	APIKeyIssuerID            string
	APIKeyEnterpriseAccount   bool
}

type Config

type Config struct {
	ProjectPath            string
	Scheme                 string
	Configuration          string
	Destination            string
	TestPlan               string
	XCConfig               string
	XcodebuildOptions      []string
	XCPretty               bool
	CodesignManager        *codesign.Manager
	OutputDir              string
	XcodebuildMajorVersion int
	CacheLevel             string
	SwiftPackagesPath      string
}

type ExportOpts

type ExportOpts struct {
	RunOut
	OutputDir string
}

type FileManager

type FileManager interface {
	ReadFile(pth string) ([]byte, error)
	WriteFile(filename string, data []byte, perm fs.FileMode) error
	ReadDir(name string) ([]os.DirEntry, error)
}

func NewFileManager

func NewFileManager() FileManager

type Input

type Input struct {
	ProjectPath   string `env:"project_path,required"`
	Scheme        string `env:"scheme,required"`
	Configuration string `env:"configuration"`
	Destination   string `env:"destination,required"`
	TestPlan      string `env:"test_plan"`
	// xcodebuild configuration
	XCConfigContent   string `env:"xcconfig_content"`
	XcodebuildOptions string `env:"xcodebuild_options"`
	// xcodebuild log formatting
	LogFormatter string `env:"log_formatter,opt[xcpretty,xcodebuild]"`
	// Automatic code signing
	CodeSigningAuthSource     string          `env:"automatic_code_signing,opt[off,api-key,apple-id]"`
	RegisterTestDevices       bool            `env:"register_test_devices,opt[yes,no]"`
	TestDeviceListPath        string          `env:"test_device_list_path"`
	MinDaysProfileValid       int             `env:"min_profile_validity,required"`
	TeamID                    string          `env:"apple_team_id"`
	CertificateURLList        string          `env:"certificate_url_list"`
	CertificatePassphraseList stepconf.Secret `env:"passphrase_list"`
	KeychainPath              string          `env:"keychain_path"`
	KeychainPassword          stepconf.Secret `env:"keychain_password"`
	BuildURL                  string          `env:"BITRISE_BUILD_URL"`
	BuildAPIToken             stepconf.Secret `env:"BITRISE_BUILD_API_TOKEN"`
	// Step output configuration
	OutputDir string `env:"output_dir,required"`
	// Caching
	CacheLevel string `env:"cache_level,opt[none,swift_packages]"`
	// App Store Connect connection override
	APIKeyPath              stepconf.Secret `env:"api_key_path"`
	APIKeyID                string          `env:"api_key_id"`
	APIKeyIssuerID          string          `env:"api_key_issuer_id"`
	APIKeyEnterpriseAccount bool            `env:"api_key_enterprise_account,opt[yes,no]"`
	// Debugging
	VerboseLog bool `env:"verbose_log,opt[yes,no]"`
}

type RunOut

type RunOut struct {
	XcodebuildLog       string
	XctestrunPths       []string
	DefaultXctestrunPth string
	SYMRoot             string
}

type XcodebuildBuilder

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

func NewXcodebuildBuilder

func NewXcodebuildBuilder(logger v2log.Logger, xcodeproject xcodeproject.XcodeProject, pathChecker v2pathutil.PathChecker, pathProvider v2pathutil.PathProvider, fileManager FileManager) XcodebuildBuilder

func (XcodebuildBuilder) ExportOutputs

func (b XcodebuildBuilder) ExportOutputs(opts ExportOpts) error

func (XcodebuildBuilder) InstallDependencies

func (b XcodebuildBuilder) InstallDependencies(useXCPretty bool) error

func (XcodebuildBuilder) ProcessConfig

func (b XcodebuildBuilder) ProcessConfig() (Config, error)

func (XcodebuildBuilder) Run

func (b XcodebuildBuilder) Run(cfg Config) (RunOut, error)