overlay

Documentation

Index

• func Write(workdir paths.FS, files []File) (overlayFile paths.FS, err error)
• type File

Functions

func Write

func Write(workdir paths.FS, files []File) (overlayFile paths.FS, err error)

Write writes the overlay files to the workdir and generates an overlay.json file suitable for passing to 'go build -overlay'. It returns the path to the written overlay.json file (which lives within workdir).

Types

type File

type File struct {
	// Source is where on the filesystem the original file (in the case of a rewrite)
	// or where the generated file should be overlaid into.
	Source paths.FS

	// Contents are the file contents of the overlaid file.
	Contents []byte

	// If set, overrides Contents and uses the dest directly instead.
	Dest paths.FS
}

File describes a file to generate or rewrite.