configcmd

package
v1.0.40357-pre Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package configcmd contains the business logic for circleci config subcommands.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LocalPipelineValues 

func LocalPipelineValues(params map[string]any) map[string]any

LocalPipelineValues fabricates the CircleCI pipeline values used when validating or processing a config locally. Git state is read best-effort; failures are silent. params are merged as pipeline.parameters.<key> and also returned separately so callers can pass them as PipelineParameters.

Types

type ValidateResult 

type ValidateResult struct {
	Valid        bool     `json:"valid"`
	CompiledYAML string   `json:"compiled_yaml,omitempty"`
	Errors       []string `json:"errors,omitempty"`
}

ValidateResult holds the outcome of a config validation call.

func Process 

func Process(ctx context.Context, client *apiclient.Client, configYAML, orgID string, params map[string]any) (*ValidateResult, error)

Process compiles the config YAML and returns the fully expanded output YAML. params are pipeline parameters injected at << pipeline.parameters.* >>.

func Validate 

func Validate(ctx context.Context, client *apiclient.Client, configYAML, orgID string) (*ValidateResult, error)

Validate compiles the config YAML against the CircleCI API and returns whether it is valid. orgID may be empty; pass one to enable private orb resolution.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.