path

Documentation

Index

• Constants

Constants

const (
	// ChartsRepositoryUpstreamBranchDir is a directory that will be used to store the latest copy of the branch containing your released assets
	ChartsRepositoryUpstreamBranchDir = "released-assets"

	// RepositoryHelmIndexFile is the file on your Staging/Live branch that contains your Helm repository index
	RepositoryHelmIndexFile = "index.yaml"
	// RepositoryPackagesDir is a directory on your Staging branch that contains the files necessary to generate your package
	RepositoryPackagesDir = "packages"
	// RepositoryAssetsDir is a directory on your Staging/Live branch that contains chart archives for each version of your package
	RepositoryAssetsDir = "assets"
	// RepositoryChartsDir is a directory on your Staging/Live branch that contains unarchived charts for each version of your package
	RepositoryChartsDir = "charts"

	// PackageOptionsFile is the name of a file that contains information about how to prepare your package
	// The expected structure of this file is one that can be marshalled into a PackageOptions struct
	PackageOptionsFile = "package.yaml"
	// PackageTemplatesDir is a directory containing templates used as additional chart options
	PackageTemplatesDir = "templates"

	// GeneratedChangesDir is a directory that contains GeneratedChanges
	GeneratedChangesDir = "generated-changes"
	// GeneratedChangesAdditionalChartDir is a directory that contains additionalCharts
	GeneratedChangesAdditionalChartDir = "additional-charts"
	// GeneratedChangesDependenciesDir is a directory that contains dependencies within GeneratedChangesDir
	GeneratedChangesDependenciesDir = "dependencies"
	// GeneratedChangesExcludeDir is a directory that contains excludes within GeneratedChangesDir
	GeneratedChangesExcludeDir = "exclude"
	// GeneratedChangesOverlayDir is a directory that contains overlays within GeneratedChangesDir
	GeneratedChangesOverlayDir = "overlay"
	// GeneratedChangesPatchDir is a directory that contains patches within GeneratedChangesDir
	GeneratedChangesPatchDir = "patch"
	// DependencyOptionsFile is a file that contains information about how to prepare your dependency
	// The expected structure of this file is one that can be marshalled into a ChartOptions struct
	DependencyOptionsFile = "dependency.yaml"

	// ChartCRDDir represents the directory that we expect to contain CRDs within the chart
	ChartCRDDir = "crds"
	// ChartExtraFileDir represents the directory that contains non-YAML files
	ChartExtraFileDir = "files"
	// ChartCRDTgzFilename represents the filename of the crd's tgz file
	ChartCRDTgzFilename = "crd-manifest.tgz"
	// ChartValidateInstallCRDFile is the path to the file pushed to upstream that validates the existence of CRDs in the chart
	ChartValidateInstallCRDFile = "templates/validate-install-crd.yaml"

	// DefaultCachePath represents the default place to put a cache on pulled values
	DefaultCachePath = ".charts-build-scripts/.cache"
)