update

Documentation

Index

• Variables
• func GetDocumentation(rootFs billy.Filesystem, chartsScriptOptions options.ChartsScriptOptions) error
• type Options
  • func (u Options) CopyTemplate(rootFs billy.Filesystem, chartsScriptOptions options.ChartsScriptOptions, ...) error

Variables

var (
	// ChartsBuildScriptsRepositoryURL is the URL pointing to the charts builds scripts
	ChartsBuildScriptsRepositoryURL = "https://github.com/rancher/charts-build-scripts.git"
	// ChartsBuildScriptsRepositoryBranch is the branch that has the latest documentation
	ChartsBuildScriptsRepositoryBranch = "master"
	// ChartsBuildScriptRepositoryTemplatesDirectory is the folder within our repository that contains templates
	ChartsBuildScriptRepositoryTemplatesDirectory = "templates"
	// ChartsBuildScriptRepositoryTemplateDirectory is the folder within templates that contains the Go templates to add to the repository
	ChartsBuildScriptRepositoryTemplateDirectory = "template"
	// ChartsBuildScriptRepositoryTemplateUpdateOptions is the file within templates that has the update options
	ChartsBuildScriptRepositoryTemplateUpdateOptions = "update.yaml"
)

Functions

func GetDocumentation

func GetDocumentation(rootFs billy.Filesystem, chartsScriptOptions options.ChartsScriptOptions) error

GetDocumentation updates a charts-build-scripts repository with the latest docs

Types

type Options

type Options map[string][]string

Options are a list of options on what files to copy

func (Options) CopyTemplate

func (u Options) CopyTemplate(rootFs billy.Filesystem, chartsScriptOptions options.ChartsScriptOptions, templateDir string) error

CopyTemplate applies the configuration to a template located in templateDir and adds it to the repo