Documentation
¶
Index ¶
- Constants
- func DefaultStepAPIVersionForWorkflowVersion(version string) (string, bool)
- func IsPublicWhenNamespace(root string) bool
- func IsSupportedStepAPIVersion(apiVersion string) bool
- func RegisterDescription() string
- func RegisterExample() string
- func ResolveStepAPIVersion(workflowVersion, stepAPIVersion string) (string, error)
- func SupportedWorkflowVersions() []string
- func WhenDescription() string
- func WhenExample() string
- func WhenNamespaces() []string
- type BuiltInTypeDefinition
- func BuiltInTypeDefinitionForKey(key StepTypeKey) (BuiltInTypeDefinition, bool, error)
- func BuiltInTypeDefinitionForKeyWith(key StepTypeKey, toolBuilder func(StepDefinition) ToolMetadata, ...) (BuiltInTypeDefinition, bool, error)
- func BuiltInTypeDefinitions() ([]BuiltInTypeDefinition, error)
- func BuiltInTypeDefinitionsWith(toolBuilder func(StepDefinition) ToolMetadata, ...) ([]BuiltInTypeDefinition, error)
- type FieldDoc
- type OutputRootConstraint
- type ParallelMetadata
- type SchemaMetadata
- type StepDefinition
- type StepTypeKey
- type ToolMetadata
Constants ¶
View Source
const ( SupportedWorkflowVersion = "v1alpha1" BuiltInStepAPIVersion = "deck/v1alpha1" )
View Source
const (
WhenLanguage = "CEL"
)
Variables ¶
This section is empty.
Functions ¶
func IsPublicWhenNamespace ¶
func RegisterDescription ¶
func RegisterDescription() string
func RegisterExample ¶
func RegisterExample() string
func ResolveStepAPIVersion ¶
func SupportedWorkflowVersions ¶
func SupportedWorkflowVersions() []string
func WhenDescription ¶
func WhenDescription() string
func WhenExample ¶
func WhenExample() string
func WhenNamespaces ¶
func WhenNamespaces() []string
Types ¶
type BuiltInTypeDefinition ¶
type BuiltInTypeDefinition struct {
Key StepTypeKey
Step StepDefinition
Docs ToolMetadata
Schema SchemaMetadata
}
func BuiltInTypeDefinitionForKey ¶
func BuiltInTypeDefinitionForKey(key StepTypeKey) (BuiltInTypeDefinition, bool, error)
func BuiltInTypeDefinitionForKeyWith ¶ added in v0.2.0
func BuiltInTypeDefinitionForKeyWith(key StepTypeKey, toolBuilder func(StepDefinition) ToolMetadata, schemaBuilder func(StepDefinition) (SchemaMetadata, error)) (BuiltInTypeDefinition, bool, error)
func BuiltInTypeDefinitions ¶
func BuiltInTypeDefinitions() ([]BuiltInTypeDefinition, error)
func BuiltInTypeDefinitionsWith ¶ added in v0.2.0
func BuiltInTypeDefinitionsWith(toolBuilder func(StepDefinition) ToolMetadata, schemaBuilder func(StepDefinition) (SchemaMetadata, error)) ([]BuiltInTypeDefinition, error)
type OutputRootConstraint ¶ added in v0.2.3
type ParallelMetadata ¶ added in v0.2.3
type ParallelMetadata struct {
ApplySafe bool
ApplyTargetPaths []string
PrepareOutput OutputRootConstraint
}
type SchemaMetadata ¶
type StepDefinition ¶
type StepDefinition struct {
APIVersion string
Kind string
Family string
FamilyTitle string
Group string
GroupOrder int
DocsPage string
DocsOrder int
SchemaFile string
ToolSchemaGenerator string
Visibility string
Category string
Summary string
WhenToUse string
Roles []string
Outputs []string
Parallel ParallelMetadata
}
func StepDefinitionForKey ¶
func StepDefinitionForKey(key StepTypeKey) (StepDefinition, bool, error)
func StepDefinitions ¶
func StepDefinitions() ([]StepDefinition, error)
type StepTypeKey ¶
Click to show internal directories.
Click to hide internal directories.