config

Documentation

Index

• func DeprecatedImageCheck(response *ConfigResponse) error
• type CompileConfigRequest
• type ConfigError
• type ConfigResponse
  • func ConfigQuery(rest *rest.Client, configPath string, orgID string, params pipeline.Parameters, ...) (*ConfigResponse, error)
• type Options

Functions

func DeprecatedImageCheck

func DeprecatedImageCheck(response *ConfigResponse) error

Processes the config down to v2.0, then checks image used against the block list

Types

type CompileConfigRequest

type CompileConfigRequest struct {
	ConfigYaml string  `json:"config_yaml"`
	Options    Options `json:"options"`
}

type ConfigError

type ConfigError struct {
	Message string `json:"message"`
}

type ConfigResponse

type ConfigResponse struct {
	Valid      bool          `json:"valid"`
	SourceYaml string        `json:"source-yaml"`
	OutputYaml string        `json:"output-yaml"`
	Errors     []ConfigError `json:"errors"`
}

func ConfigQuery

func ConfigQuery(
	rest *rest.Client,
	configPath string,
	orgID string,
	params pipeline.Parameters,
	values pipeline.Values,
) (*ConfigResponse, error)

ConfigQuery - attempts to compile or validate a given config file with the passed in params/values. If the orgID is passed in, the config-compilation with private orbs should work.

type Options

type Options struct {
	OwnerID            string            `json:"owner_id,omitempty"`
	PipelineParameters string            `json:"pipeline_parameters,omitempty"`
	PipelineValues     map[string]string `json:"pipeline_values,omitempty"`
}