codegen

Documentation

Index

• Constants
• type Command
  • func (c Command) Execute() error

Constants

const (
	DefaultHeader = "Code generated by skv2. DO NOT EDIT."
)

Types

type Command

type Command struct {
	// the name of the app or component
	// used to label k8s manifests
	AppName string

	// config to vendor protos and other non-go files
	// Optional: If nil will not be used
	AnyVendorConfig *skv2_anyvendor.Imports

	// Patches to apply to vendored proto files after vendoring
	// Can be used e.g.
	ProtoFilePatches []protovendor.ProtoFilePatcher

	// the k8s api groups for which to compile
	Groups []render.Group

	// protoc cmd line options
	GroupOptions model.GroupOptions

	// top-level custom templates to render.
	// these will recieve all groups as inputs
	TopLevelTemplates []model.CustomTemplates

	// optional helm chart to render
	Chart *model.Chart

	// the root directory for generated Kube manifests
	ManifestRoot string

	// optional Go/Docker images to build
	Builds []model.Build

	// the root directory for Build files (Dockerfile, entrypoint script, etc.)
	BuildRoot string

	// Header to prepend to generated files.
	// If not set will default to: "Code generated by skv2. DO NOT EDIT."
	// The string will auto prepend the comment character depending on the file type it is being written to.
	GeneratedHeader string

	// custom builder to shim Go Build and Docker Build commands (for testing)
	// If not provided, skv2 will exec
	// go and docker commands
	Builder builder.Builder

	// Should we compile protos?
	RenderProtos bool

	// search protos recursively starting from this directory.
	// will default vendor_any if empty
	ProtoDir string

	// protoc cmd line options
	ProtocOptions collector.ProtocOptions

	// Custom go arguments used while compiling protos
	CustomGoArgs []string

	// the name of the flag to pass the list of enabled alpha-level crds
	// used in codegen/templates/manifests/crd.yamltmpl
	EnabledAlphaApiFlagName string

	// Optional: If true, skip rendering the CRD manifest
	SkipCrdsManifest bool
	// contains filtered or unexported fields
}

runs the codegen compilation for the current Go module

func (Command) Execute

func (c Command) Execute() error

function to execute skv2 code gen from another repository