taskdoc

Documentation

Overview

Package taskdoc implements documentation rendering for tasks. It is intended to be run via `go run`, passing a task YAML manifest and a description in Asciidoctor format. The combined result will be written to the specified destination.

Example invocation:

go run github.com/opendevstack/ods-pipeline/cmd/taskdoc \
	-task tasks/my-task.yaml \
	-description build/docs/my-task.adoc \
	-destination docs/my-task.adoc

By default, taskdoc will use the template located at docs/tasks/template.adoc.tmpl to produce the resulting file. Another template can be specified via -template:

go run github.com/opendevstack/ods-pipeline/cmd/taskdoc \
	-task tasks/my-task.yaml \
	-description build/docs/my-task.adoc \
	-template /path/to/my-custom-template.adoc.tmpl \
	-destination docs/my-task.adoc