Documentation
¶
Overview ¶
Package template holds the files archdoc writes: the document templates, the process description, and the scaffolding init produces. They are embedded so that the binary carries everything a repository needs.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Files embed.FS
Files is every embedded file, exposed so that init can write out the ones it scaffolds without rendering them.
Functions ¶
Types ¶
type Data ¶
type Data struct {
ID string
Title string
Date string
Name string
Version string
// Status is the lifecycle status to create the document in. Backfilled
// documents arrive terminal; everything else starts as a draft.
Status string
// Decided is the date a terminal document reached its status.
Decided string
// Backfilled is the date the document was written, when it records a
// decision taken earlier. Empty for an ordinary document.
Backfilled string
// Year is the copyright year, for the licence.
Year string
// WorkingDirectory is where the generated workflow runs archdoc: the path
// from the git repository root to the directory holding archdoc.json.
WorkingDirectory string
}
Data is the substitution set. A field left empty renders as absent rather than as an empty value, so the same template serves an ordinary draft and a backfilled document.
Click to show internal directories.
Click to hide internal directories.