vega

Documentation

Index

• Constants
• Variables
• func CheckForLatestVersion()
• type GitHooks
  • func (gitHook *GitHooks) Add()
  • func (gitHook *GitHooks) Install(path string)
  • func (gitHook *GitHooks) InstallGlobally()
• type Home
  • func (home Home) GitHooks() string
  • func (home Home) Logs() string
  • func (home Home) Path(elements ...string) string
  • func (home Home) StarterKits() string
  • func (home Home) String() string
• type StarterKit
  • func (sk *StarterKit) Create(dest string) error
  • func (sk *StarterKit) Install(dest string) error
• type StarterKitRepo
  • func RepoList(path string) ([]StarterKitRepo, error)
  • func (repo *StarterKitRepo) Add()
  • func (repo StarterKitRepo) Delete()
  • func (repo *StarterKitRepo) Find(name string) ([]StarterKit, error)
  • func (repo *StarterKitRepo) StarterKitList() (StarterKits, error)
• type StarterKitRepos
• type StarterKits

Constants

const DockerfileName string = "Dockerfile"

DockerfileName: Default dockerfile name used in starterkits

Variables

var ErrStarterKitNotFoundInRepo = errors.New("starterkit not found")

ErrStarterKitNotFoundInRepo is the error returned when a starterkit is not found in a starterkits

Functions

func CheckForLatestVersion

func CheckForLatestVersion()

CheckForLatestVersion checks for latest releases

Types

type GitHooks

type GitHooks struct {
	Home Home
	URL  string
	Dir  string // hooks directory name at source/remote
	Out  io.Writer
}

func (*GitHooks) Add

func (gitHook *GitHooks) Add()

Add downloads git hooks to vega home

func (*GitHooks) Install

func (gitHook *GitHooks) Install(path string)

Install installs Git Hooks to a git based project path

func (*GitHooks) InstallGlobally

func (gitHook *GitHooks) InstallGlobally()

InstallGlobally installs Git Hooks as Global Git Hooks

type Home

type Home string

This builds paths relative to a Vega Home directory.

func (Home) GitHooks

func (home Home) GitHooks() string

func (Home) Logs

func (home Home) Logs() string

func (Home) Path

func (home Home) Path(elements ...string) string

func (Home) StarterKits

func (home Home) StarterKits() string

func (Home) String

func (home Home) String() string

type StarterKit

type StarterKit struct {
	Name string
	Path string
}

StarterKit represents a starterkit repository.

func (*StarterKit) Create

func (sk *StarterKit) Create(dest string) error

Create creates a new project at dest from given starter kit

func (*StarterKit) Install

func (sk *StarterKit) Install(dest string) error

Install installs a starterkit at existing project

type StarterKitRepo

type StarterKitRepo struct {
	Name string
	Path string // local absolute path to repo
	Home Home
	URL  string
	Dir  string // starterkits directory name at source/remote
}

func RepoList

func RepoList(path string) ([]StarterKitRepo, error)

RepoList list of all the local Repositories

func (*StarterKitRepo) Add

func (repo *StarterKitRepo) Add()

Add adds repo and starterkits to vega

func (StarterKitRepo) Delete

func (repo StarterKitRepo) Delete()

Delete deletes the starterkit repo

func (*StarterKitRepo) Find

func (repo *StarterKitRepo) Find(name string) ([]StarterKit, error)

Find returns the starterkits matching with the given name

func (*StarterKitRepo) StarterKitList

func (repo *StarterKitRepo) StarterKitList() (StarterKits, error)

StarterKitList Gets the list of all StarterKits for given repo.

type StarterKitRepos

type StarterKitRepos []StarterKitRepo

type StarterKits

type StarterKits []StarterKit