tpl

Documentation

Index

• func GetLocalTemplateInfo(name string) (*git.RepoInfo, error)
• func ImportTemplate(url string) (*vcsurl.VCS, error)
• func InstallTemplate(name string) error
• func ListCachedRepos() ([]*git.RepoInfo, error)
• func ListTemplates() ([]*git.RepoInfo, error)
• func RemoveTemplate(name string) error
• func SearchRegistry(substring string) ([]*git.RepoInfo, error)
• func SearchTemplates(pattern string) ([]*git.RepoInfo, error)
• func UpdateRegistry() error
• func UpgradeAllTemplates() error
• func UpgradeTemplates(names []string) error
• func WriteRegistry(r *TemplateRegistry) error
• type TemplateInfo
• type TemplateRegistry
  • func ReadRegistry() (*TemplateRegistry, error)

Functions

func GetLocalTemplateInfo

func GetLocalTemplateInfo(name string) (*git.RepoInfo, error)

GetLocalTemplateInfo returns information about a template either from an installed of from a template registry

func ImportTemplate

func ImportTemplate(url string) (*vcsurl.VCS, error)

ImportTemplate imports template from git repository into the cache

func InstallTemplate

func InstallTemplate(name string) error

InstallTemplate installs template template registry into the cache

func ListCachedRepos

func ListCachedRepos() ([]*git.RepoInfo, error)

ListTemplates lists all templates in the cache

func ListTemplates

func ListTemplates() ([]*git.RepoInfo, error)

ListTemplates lists all templates in the cache

func RemoveTemplate

func RemoveTemplate(name string) error

RemoveTemplate removes template by name from the cache

func SearchRegistry

func SearchRegistry(substring string) ([]*git.RepoInfo, error)

func SearchTemplates

func SearchTemplates(pattern string) ([]*git.RepoInfo, error)

func UpdateRegistry

func UpdateRegistry() error

UpdateRegistry updates the local template registry The registry is a git repository that contains a list of templates and their versions.

func UpgradeAllTemplates

func UpgradeAllTemplates() error

UpgradeAllTemplates upgrade all templates from remote git repo

func UpgradeTemplates

func UpgradeTemplates(names []string) error

UpgradeTemplates upgrade templates from remote git repo

func WriteRegistry

func WriteRegistry(r *TemplateRegistry) error

WriteRegistry writes the registry to path

Types

type TemplateInfo

type TemplateInfo struct {
	Name       string `json:"name"`
	Git        string `json:"git"`
	Commit     string `json:"commit"`
	Path       string `json:"path"`
	InCache    bool   `json:"inCache"`
	InRegistry bool   `json:"inRegistry"`
}

TemplateInfo contains information about a template

type TemplateRegistry

type TemplateRegistry struct {
	Name        string          `json:"name"`
	Description string          `json:"description"`
	Entries     []*git.RepoInfo `json:"entries"`
}

func ReadRegistry

func ReadRegistry() (*TemplateRegistry, error)

ReadRegistry reads the registry file from path