askcatalog

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Jun 19, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AllowedGeneratedPath

func AllowedGeneratedPath(path string) bool

func AllowedGeneratedPathPatterns

func AllowedGeneratedPathPatterns() []string

Types

type Binding

type Binding struct {
	Path     string
	From     string
	Semantic string
	Required bool
}

type Builder

type Builder struct {
	ID                   string
	StepKind             string
	Phase                string
	DefaultStepID        string
	Summary              string
	RequiresCapabilities []string
	Bindings             []Binding
	SourceRefs           []string
}

func (Builder) OptionalOverrideKeys

func (b Builder) OptionalOverrideKeys() []string

func (Builder) OverrideKeys

func (b Builder) OverrideKeys() []string

func (Builder) RequiredOverrideKeys

func (b Builder) RequiredOverrideKeys() []string

type Catalog

type Catalog struct {
	Workflow   WorkflowRules
	Workspace  WorkspaceRules
	Policy     PolicyRules
	Modes      []ModeRules
	Components ComponentRules
	Vars       VarsRules
	Steps      map[string]Step
	// contains filtered or unexported fields
}

func Current

func Current() Catalog

func (Catalog) BuilderIDsForPath added in v0.2.2

func (c Catalog) BuilderIDsForPath(path string) []string

func (Catalog) BuildersForPath added in v0.2.2

func (c Catalog) BuildersForPath(path string) []Builder

func (Catalog) LookupBuilder

func (c Catalog) LookupBuilder(id string) (Builder, bool)

func (Catalog) LookupField

func (c Catalog) LookupField(kind string, path string) (Field, bool)

func (Catalog) LookupStep

func (c Catalog) LookupStep(kind string) (Step, bool)

func (Catalog) StepKinds

func (c Catalog) StepKinds() []Step

type ComponentRules added in v0.2.2

type ComponentRules struct {
	Summary         string
	ImportRule      string
	ReuseRule       string
	LocationRule    string
	FragmentRule    string
	ImportExample   string
	FragmentExample string
	AllowedRootKeys []string
	SourceRefs      []string
}

type ContractBindings

type ContractBindings struct {
	ProducesArtifacts   []string
	ConsumesArtifacts   []string
	PublishesState      []string
	ConsumesState       []string
	RoleSensitive       bool
	VerificationRelated bool
}

type Field

type Field struct {
	Path               string
	Type               string
	Requirement        schemafacts.RequirementLevel
	Default            string
	Pattern            string
	Enum               []string
	Description        string
	Example            string
	ConstrainedLiteral bool
	Guidance           string
	SourceRef          string
}

type ModeRules added in v0.2.2

type ModeRules struct {
	Mode        string
	Summary     string
	WhenToUse   string
	Prefer      []string
	Avoid       []string
	OutputFiles []string
	SourceRefs  []string
}

type PolicyRules added in v0.2.2

type PolicyRules struct {
	AssumeOfflineByDefault bool
	PreferTypedSteps       bool
	PrepareArtifactKinds   []string
	ForbiddenApplyActions  []string
	VarsAdvisory           []string
	ComponentAdvisory      []string
	SourceRefs             []string
}

type Step

type Step struct {
	Kind                     string
	Category                 string
	Group                    string
	GroupTitle               string
	GroupAliases             []string
	Summary                  string
	WhenToUse                string
	SchemaFile               string
	AllowedRoles             []string
	Outputs                  []string
	Capabilities             []string
	Contract                 ContractBindings
	MatchSignals             []string
	AntiSignals              []string
	ValidationHints          []stepmeta.ValidationHint
	ConstrainedLiteralFields []stepmeta.ConstrainedLiteralField
	QualityRules             []stepmeta.QualityRule
	KeyFields                []string
	Fields                   map[string]Field
	RuleSummaries            []string
	Builders                 []Builder
	SourceRefs               []string
}

type VarsRules added in v0.2.2

type VarsRules struct {
	Path        string
	Summary     string
	PreferFor   []string
	AvoidFor    []string
	ExampleKeys []string
	SourceRefs  []string
}

type WorkflowRules

type WorkflowRules struct {
	Summary          string
	SupportedVersion string
	TopLevelModes    []string
	SupportedModes   []string
	RequiredFields   []string
	ImportRule       string
	PhaseRules       []string
	StepRules        []string
	PhaseExample     string
	StepsExample     string
	InvariantNotes   []string
	SourceRefs       []string
}

type WorkspaceRules

type WorkspaceRules struct {
	WorkflowRoot      string
	ScenarioDir       string
	ComponentDir      string
	VarsPath          string
	AllowedPaths      []string
	CanonicalPrepare  string
	CanonicalApply    string
	GeneratedPathNote string
	SourceRefs        []string
}

Jump to

Keyboard shortcuts

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