run

Documentation

Index

• Variables
• func Create(p *api_v1.PluginPlaceholders, executor execute.Executor, t tmpl.TmplWriter) error
• func GenerateDocs(p *api_v1.PluginPlaceholders, targetDir string, check bool, t tmpl.TmplWriter) error

Variables

var Fswalkdir = fs.WalkDir

Functions

func Create

func Create(p *api_v1.PluginPlaceholders, executor execute.Executor, t tmpl.TmplWriter) error

func GenerateDocs

func GenerateDocs(p *api_v1.PluginPlaceholders, targetDir string, check bool, t tmpl.TmplWriter) error

Generates a table of contents for ./docs/<topic>/README.md files and a list of all services in a jarvis project. TargetDir should be a jarvis project root directory. If check is true, GenerateDocs will instead check the current docs and exit with error code 1 if docs are not up to date.

TODO generate graph