witnesscommand

Documentation

Index

• type Command
  • func Admit(raw any, rawVocabulary any) (Command, error)
  • func AdmitWithVocabulary(raw any, vocabulary Vocabulary) (Command, error)
  • func (command Command) JSONValue() map[string]any
• type EnvironmentClassPolicy
• type EnvironmentPolicy
• type ExitCodePolicy
• type ExpectedArtifact
• type Plan
  • func PlanCommands(commands []Command) (Plan, error)
  • func (plan Plan) JSONValue() map[string]any
• type PlanGroup
• type Vocabulary
  • func AdmitVocabulary(raw any) (Vocabulary, error)

Types

type Command

type Command struct {
	Argv              []string
	CachePolicy       string
	CredentialClass   string
	Cwd               string
	Environment       EnvironmentPolicy
	ExitCodePolicy    ExitCodePolicy
	ExpectedArtifacts []ExpectedArtifact
	ID                string
	NetworkPolicy     string
	ParallelGroup     string
	TimeoutMs         int
}

func Admit

func Admit(raw any, rawVocabulary any) (Command, error)

func AdmitWithVocabulary

func AdmitWithVocabulary(raw any, vocabulary Vocabulary) (Command, error)

func (Command) JSONValue

func (command Command) JSONValue() map[string]any

type EnvironmentClassPolicy

type EnvironmentClassPolicy struct {
	CachePolicies     []string
	CredentialClasses []string
	EnvironmentClass  string
	NetworkPolicies   []string
}

type EnvironmentPolicy

type EnvironmentPolicy struct {
	Allowlist []string
	Classes   []string
	Inherit   string
}

type ExitCodePolicy

type ExitCodePolicy struct {
	Kind         string
	SuccessCodes []int
}

type ExpectedArtifact

type ExpectedArtifact struct {
	Kind     string
	Path     string
	Required bool
}

type Plan

type Plan struct {
	Commands       []Command
	ParallelGroups []PlanGroup
}

func PlanCommands

func PlanCommands(commands []Command) (Plan, error)

func (Plan) JSONValue

func (plan Plan) JSONValue() map[string]any

type PlanGroup

type PlanGroup struct {
	CommandIDs    []string
	ParallelGroup string
}

type Vocabulary

type Vocabulary struct {
	ArtifactKinds                 []string
	CredentialClasses             []string
	EnvironmentClasses            []string
	EnvironmentClassPolicies      []EnvironmentClassPolicy
	MaxTimeoutMs                  int
	NonCacheableCredentialClasses []string
	ParallelGroups                []string
}

func AdmitVocabulary

func AdmitVocabulary(raw any) (Vocabulary, error)