generator

Documentation

Index

• Variables
• func GenerateStageDocumentation(stageMetadataPath, stageTargetPath, relativeStepsPath string, ...) error
• func GenerateStepDocumentation(metadataFiles []string, customDefaultFiles []string, ...) error
• type CustomLibrary
• type DocuHelperData

Variables

var CustomLibrarySteps = []CustomLibrary{}

CustomLibrarySteps holds a list of libraries with it's custom steps.

Functions

func GenerateStageDocumentation

func GenerateStageDocumentation(stageMetadataPath, stageTargetPath, relativeStepsPath string, utils piperutils.FileUtils) error

GenerateStepDocumentation generates pipeline stage documentation based on pipeline configuration provided in a yaml file

func GenerateStepDocumentation

func GenerateStepDocumentation(metadataFiles []string, customDefaultFiles []string, docuHelperData DocuHelperData, azure bool) error

GenerateStepDocumentation generates step coding based on step configuration provided in yaml files

Types

type CustomLibrary

type CustomLibrary struct {
	Name        string   `yaml: "name,omitempty"`
	BinaryName  string   `yaml: "binaryName,omitempty"`
	LibraryName string   `yaml: "libraryName,omitempty"`
	Steps       []string `yaml: "steps,omitempty"`
}

CustomLibrary represents a custom library with it's custom step names, binary name and library name.

type DocuHelperData

type DocuHelperData struct {
	DocTemplatePath     string
	OpenDocTemplateFile func(d string) (io.ReadCloser, error)
	DocFileWriter       func(f string, d []byte, p os.FileMode) error
	OpenFile            func(s string) (io.ReadCloser, error)
}

DocuHelperData is used to transport the needed parameters and functions from the step generator to the docu generation.