markers

Documentation

Index

• Constants
• func Register(into *markers.Registry) error
• type Param
  • func (Param) Help() *markers.DefinitionHelp
• type Result
  • func (Result) Help() *markers.DefinitionHelp
• type Task
  • func (Task) Help() *markers.DefinitionHelp
• type Workspace
  • func (Workspace) Help() *markers.DefinitionHelp

Constants

const (
	MarkerParam     = "tektasker:param"
	MarkerResult    = "tektasker:result"
	MarkerTask      = "tektasker:task"
	MarkerWorkspace = "tektasker:workspace"
)

Functions

func Register

func Register(into *markers.Registry) error

Register all the markers in passed markers.Registry

Types

type Param

type Param struct {
	// Name is the name of your parameter
	Name string `marker:"name"`

	// Default is the default value of the parameter
	Default *string `marker:",optional"`

	// Strict means you expect the parameter to strictly respect the format
	// of your struct. For this to be possible, the value passed to this parameter
	// by your user will need to be a valid JSON value that can be
	// unmarshalled into your struct, that's why you need to put valid JSON tags
	// in your structure fields.
	Strict bool `marker:",optional"`
}

Param marks structs as Task parameter which can then be used in your code to take input from your users

func (Param) Help

func (Param) Help() *markers.DefinitionHelp

type Result

type Result struct {
	// Name is the name of the result
	Name string `marker:"name"`
}

Result marks this struct as a result which means it can be Marshaled to populate the associated result

func (Result) Help

func (Result) Help() *markers.DefinitionHelp

type Task

type Task struct {
	// Name is the name of your Task.
	// It will be used as the name of your Task manifest.
	Name string `marker:"name"`

	// Version is a way to communicate the version of your task to
	// your users
	Version string `marker:"version"`
}

Task marks your package as a Task. Your package need to be executable to be bundled inside a container image, so you should use this marker on your main package

func (Task) Help

func (Task) Help() *markers.DefinitionHelp

type Workspace

type Workspace struct {
	// Name is the name of the workspace
	Name string `marker:"name"`

	// Description for your workspace
	Description string `marker:"description"`

	// MountPath is useful to chose where to mount your workspace and
	// is always relative to root (`/`)
	MountPath string `marker:"mountPath,optional"`

	// ReadOnly defines if your workspace should be Read-Only,
	// remembers Tekton recommends to only have a single writeable
	// workspace
	ReadOnly bool `marker:"readOnly,optional"`

	// Optional defines if your user can choose not to provide this
	// workspace
	Optional bool `marker:"optional,optional"`
}

Workspace asks a workspace for this task

func (Workspace) Help

func (Workspace) Help() *markers.DefinitionHelp