getter_helper

Documentation

Index

• func DownloadTemplatesToTemporaryFolder(templateUrl string) (string, string, error)
• func NewGetterClient(src string, dst string) (*getter.Client, error)
• func ParseGetterUrl(templateUrl string) (*url.URL, error)
• func ValidateTemplateUrl(templateUrl string) error
• type FileCopyGetter
  • func (g *FileCopyGetter) Get(dst string, u *url.URL) error
  • func (g *FileCopyGetter) GetFile(dst string, u *url.URL) error

Functions

func DownloadTemplatesToTemporaryFolder

func DownloadTemplatesToTemporaryFolder(templateUrl string) (string, string, error)

DownloadTemplatesToTemporaryFolder uses the go-getter library to fetch the templates from the configured URL to a temporary folder and returns the path to that folder. If there is a subdir in the template URL, return the combined path as well.

func NewGetterClient

func NewGetterClient(src string, dst string) (*getter.Client, error)

We use this code to force go-getter to copy files instead of creating symlinks.

func ParseGetterUrl

func ParseGetterUrl(templateUrl string) (*url.URL, error)

func ValidateTemplateUrl

func ValidateTemplateUrl(templateUrl string) error

ValidateTemplateUrl returns an error if the template URL is not following one of the supported detector patterns.

Types

type FileCopyGetter

type FileCopyGetter struct {
	getter.FileGetter
}

A custom getter.Getter implementation that uses file copying instead of symlinks. Symlinks are faster and use less disk space, but they cause issues in Windows and with infinite loops, so we copy files/folders instead.

func (*FileCopyGetter) Get

func (g *FileCopyGetter) Get(dst string, u *url.URL) error

The original FileGetter does NOT know how to do folder copying (it only does symlinks), so we provide a copy implementation here

func (*FileCopyGetter) GetFile

func (g *FileCopyGetter) GetFile(dst string, u *url.URL) error

The original FileGetter already knows how to do file copying so long as we set the Copy flag to true, so just delegate to it