taskdoc

Documentation

Index

• func RenderTaskDocumentation(w io.Writer, tmpl *template.Template, task *Task) error
• type Param
• type Result
• type Task
  • func ParseTask(f []byte, desc []byte) (*Task, error)

Functions

func RenderTaskDocumentation

func RenderTaskDocumentation(w io.Writer, tmpl *template.Template, task *Task) error

RenderTaskDocumentation renders the given template with the task data, writing the result to w.

Types

type Param

type Param struct {
	Name        string
	Default     string
	Description string
}

type Result

type Result struct {
	Name        string
	Description string
}

type Task

type Task struct {
	Name        string
	Description string
	Params      []Param
	Results     []Result
}

func ParseTask

func ParseTask(f []byte, desc []byte) (*Task, error)

ParseTask reads a Tekton task from given bytes f, and assembles a new Task with the name, params and results from the parsed Tekton task, as well as the given description.