Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNoCredentials = errors.New("no access token or platform credentials provided") ErrPlatformCredentialConflict = errors.New("OAuth credentials and a platform token can't be used at the same time") )
Functions ¶
Types ¶
type Context ¶
type Context struct {
// Fs holds the abstraction of the file system.
Fs afero.Fs
// ManifestPath holds the path from where the manifest should be loaded.
ManifestPath string
// Environments is a filter to what environments should be loaded.
// If it's empty, all environments are loaded.
// If both Environments and Groups are specified, the union of both results is returned.
//
// If Environments contains items that do not match any environment in the specified manifest file, the loading errors.
Environments []string
// Account is a filter to what account should be loaded.
// If it's empty, all accounts are loaded.
//
// If Account contains an account that does not match any account in the specified manifest file, the loading errors.
Account string
// Groups is a filter to what environment-groups (and thus environments) should be loaded.
// If it's empty, all environment-groups are loaded.
// If both Environments and Groups are specified, the union of both results is returned.
//
// If Groups contains items that do not match any environment in the specified manifest file, the loading errors.
Groups []string
// Opts are Options holding optional configuration for Load
Opts Options
}
Context holds all information for Load
type EnvironmentDetails ¶
type EnvironmentLoaderError ¶
type EnvironmentLoaderError struct {
ManifestLoaderError
// EnvironmentDetails of the environment that failed to be loaded
EnvironmentDetails EnvironmentDetails `json:"environmentDetails"`
}
func (EnvironmentLoaderError) Error ¶
func (e EnvironmentLoaderError) Error() string
type ManifestLoaderError ¶
type ManifestLoaderError struct {
// ManifestPath is the path of the manifest file that failed to load
ManifestPath string `json:"manifestPath"`
// Reason describing what went wrong
Reason string `json:"reason"`
}
func (ManifestLoaderError) Error ¶
func (e ManifestLoaderError) Error() string
type ProjectLoaderError ¶
type ProjectLoaderError struct {
ManifestLoaderError
// Project name that failed to be loaded
Project string `json:"project"`
}
func (ProjectLoaderError) Error ¶
func (e ProjectLoaderError) Error() string
Click to show internal directories.
Click to hide internal directories.