common

Documentation

Index

• Constants
• func SelectEndpointURL(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 NewCacheConfigMetadata(envProvider EnvProviderFunc) CacheConfigMetadata
• type EnvProviderFunc

Constants

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

Functions

func SelectEndpointURL

func SelectEndpointURL(endpointURL string, envProvider func(string) string) string

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

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 - if BITRISEIO_BITRISE_SERVICES_ACCESS_TOKEN is provided, use that - otherwise, if BITRISE_BUILD_CACHE_AUTH_TOKEN and BITRISE_BUILD_CACHE_WORKSPACE_ID is provided, use that - otherwise return error

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
	// BitriseCI specific
	BitriseAppID        string
	BitriseWorkflowName string
	BitriseBuildID      string
}

func NewCacheConfigMetadata

func NewCacheConfigMetadata(envProvider EnvProviderFunc) CacheConfigMetadata

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

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.