common

Documentation

Index

• Constants
• Variables
• func SelectCacheEndpointURL(endpointURL string, envProvider func(string) string) string
• func SelectRBEEndpointURL(endpointURL string, envProvider func(string) string) string
• type CacheAuthConfig
  • func ReadAuthConfigFromEnvironments(envProvider func(string) string) (CacheAuthConfig, error)
  • func (cac CacheAuthConfig) TokenInGradleFormat() string
• type CacheConfigMetadata
  • func NewMetadata(envProvider EnvProviderFunc, commandFunc CommandFunc, logger log.Logger) CacheConfigMetadata
• type CommandFunc
• type EnvProviderFunc
• type HostMetadata

Constants

const (
	// CIProviderBitrise ...
	CIProviderBitrise = "bitrise"
	// CIProviderCircleCI ...
	CIProviderCircleCI = "circle-ci"
	// CIProviderGitHubActions ...
	CIProviderGitHubActions = "github-actions"
)

Variables

var (
	ErrAuthTokenNotProvided   = errors.New("BITRISE_BUILD_CACHE_AUTH_TOKEN or BITRISEIO_BITRISE_SERVICES_ACCESS_TOKEN environment variable not set")
	ErrWorkspaceIDNotProvided = errors.New("BITRISE_BUILD_CACHE_WORKSPACE_ID environment variable not set")
)

Functions

func SelectCacheEndpointURL

func SelectCacheEndpointURL(endpointURL string, envProvider func(string) string) string

SelectCacheEndpointURL - if endpointURL provided use that, otherwise select the best build cache endpoint automatically

func SelectRBEEndpointURL

func SelectRBEEndpointURL(endpointURL string, envProvider func(string) string) string

SelectRBEEndpointURL - if endpointURL provided use that, otherwise select the RBE endpoint from environment

Types

type CacheAuthConfig

type CacheAuthConfig struct {
	AuthToken   string
	WorkspaceID string
}

CacheAuthConfig holds the auth config for the cache.

func ReadAuthConfigFromEnvironments

func ReadAuthConfigFromEnvironments(envProvider func(string) string) (CacheAuthConfig, error)

ReadAuthConfigFromEnvironments reads auth information from the environment variables

func (CacheAuthConfig) TokenInGradleFormat

func (cac CacheAuthConfig) TokenInGradleFormat() string

TokenInGradleFormat returns the auth token in gradle format.

type CacheConfigMetadata

type CacheConfigMetadata struct {
	CIProvider   string
	RepoURL      string
	HostMetadata HostMetadata
	// BitriseCI specific
	BitriseAppID        string
	BitriseWorkflowName string
	BitriseBuildID      string
	Datacenter          string
}

func NewMetadata

func NewMetadata(envProvider EnvProviderFunc, commandFunc CommandFunc, logger log.Logger) CacheConfigMetadata

NewMetadata creates a new CacheConfigMetadata instance based on the environment variables.

type CommandFunc

type CommandFunc func(string, ...string) (string, error)

type EnvProviderFunc

type EnvProviderFunc func(string) string

EnvProviderFunc is a function which returns the value of an environment variable. It's compatible with os.Getenv - os.Getenv can be passed as an EnvProviderFunc.

type HostMetadata

type HostMetadata struct {
	OS             string
	CPUCores       int
	MemSize        int64
	Locale         string
	DefaultCharset string
}

HostMetadata contains metadata about the local environment. Only used for Bazel to generate bazelrc. For Gradle, it's done by the plugin dynamically.