common

package

v0.6.0 Latest Latest Go to latest Published: Jan 26, 2024 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bitrise-io/bitrise-build-cache-cli

Links

Open Source Insights

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 CacheConfig
- func NewCacheConfig(envProvider EnvProviderFunc) CacheConfig
type EnvProviderFunc

Constants ¶

View Source

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

Variables ¶

This section is empty.

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 CacheConfig ¶ added in v0.6.0

type CacheConfig struct {
	CIProvider string
	RepoURL    string
	// BitriseCI specific
	BitriseAppID        string
	BitriseStepID       string
	BitriseWorkflowName string
	BitriseBuildID      string
}

func NewCacheConfig ¶ added in v0.6.0

func NewCacheConfig(envProvider EnvProviderFunc) CacheConfig

NewCacheConfig creates a new CacheConfig instance based on the environment variables.

type EnvProviderFunc ¶ added in v0.6.0

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL